Setera Onecloud admin API (5.6.24412)
Setera Onecloud admin API
The Queue Statistics API gives access to statistics on ACD and attendant groups. Queue statistics is authenticated using api tickets for Queue statistics.
To be able to fetch the queue statistics, the Supervisor license must be assigned to the organization.
Use the Queue Statistics API to:
- Get queue statistics for an organization
- Get queue statistics for a user
- Get queue statistics for a queue
Get organization queue statistics
Retrieve the queue statistics for an organization.
Authorizations:
path Parameters
| domain required | string The domain queue statistics shall be fetched for |
Responses
Response samples
- 200
{- "queue": [
- {
- "name": "ACD_Taxi",
- "domain": "test.com",
- "number": "+123415",
- "id": 67899,
- "queueLength": 3,
- "availableAgents": 2,
- "loggedInAgents": 5,
- "longestWaiting": 20,
- "lastWait": 15,
- "averageWait": 14,
- "droppedCallsForPeriod": 6,
- "totalCallsForPeriod": 60,
- "answeredCallsForPeriod": 41,
- "totalCallsLast24h": 50,
- "droppedCallsLast24h": 4,
- "answeredCallsLast24h": 38,
- "current-agent-presence": [
- {
- "name": "Available",
- "count": 1
}
]
}
]
}Get organization queue statistics Deprecated
Retrieve the queue statistics for an organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain queue statistics shall be fetched for |
Responses
Response samples
- 200
{- "queue": [
- {
- "name": "ACD_Taxi",
- "domain": "test.com",
- "number": "+123415",
- "id": 67899,
- "queueLength": 3,
- "availableAgents": 2,
- "loggedInAgents": 5,
- "longestWaiting": 20,
- "lastWait": 15,
- "averageWait": 14,
- "droppedCallsForPeriod": 6,
- "totalCallsForPeriod": 60,
- "answeredCallsForPeriod": 41,
- "totalCallsLast24h": 50,
- "droppedCallsLast24h": 4,
- "answeredCallsLast24h": 38,
- "current-agent-presence": [
- {
- "name": "Available",
- "count": 1
}
]
}
]
}Get queue statistics for queue
Retrieve queue statistics for a distribution group.
Authorizations:
path Parameters
| domain required | string The domain of the group queue statistics shall be fetched for |
| queueId required | string The id of the group queue statistics shall be fetched for |
Responses
Response samples
- 200
- 400
{- "name": "ACD_Taxi",
- "domain": "test.com",
- "number": "+123415",
- "id": 67899,
- "queueLength": 3,
- "availableAgents": 2,
- "loggedInAgents": 5,
- "longestWaiting": 20,
- "lastWait": 15,
- "averageWait": 14,
- "droppedCallsForPeriod": 6,
- "totalCallsForPeriod": 60,
- "answeredCallsForPeriod": 41,
- "totalCallsLast24h": 50,
- "droppedCallsLast24h": 4,
- "answeredCallsLast24h": 38,
- "current-agent-presence": [
- {
- "name": "Available",
- "count": 1
}
]
}Get user queue statistics
Retrieve queue statistics for a user who is authorized to supervise specific groups.
Authorizations:
path Parameters
| domain required | string The domain of the user queue statistics shall be fetched for |
| user required | string The username of the user queue statistics shall be fetched for |
query Parameters
| includeFederation | boolean If queue statistics from federated organizations shall be included (default false) |
Responses
Response samples
- 200
{- "queue": [
- {
- "name": "ACD_Taxi",
- "domain": "test.com",
- "number": "+123415",
- "id": 67899,
- "queueLength": 3,
- "availableAgents": 2,
- "loggedInAgents": 5,
- "longestWaiting": 20,
- "lastWait": 15,
- "averageWait": 14,
- "droppedCallsForPeriod": 6,
- "totalCallsForPeriod": 60,
- "answeredCallsForPeriod": 41,
- "totalCallsLast24h": 50,
- "droppedCallsLast24h": 4,
- "answeredCallsLast24h": 38,
- "current-agent-presence": [
- {
- "name": "Available",
- "count": 1
}
]
}
]
}Get user queue statistics Deprecated
Retrieve queue statistics based on a specific supervisor who is authorized to supervise specific groups.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain queue statistics shall be fetched for |
| user required | string The username of the user accessing the API |
Responses
Response samples
- 200
{- "queue": [
- {
- "name": "ACD_Taxi",
- "domain": "test.com",
- "number": "+123415",
- "id": 67899,
- "queueLength": 3,
- "availableAgents": 2,
- "loggedInAgents": 5,
- "longestWaiting": 20,
- "lastWait": 15,
- "averageWait": 14,
- "droppedCallsForPeriod": 6,
- "totalCallsForPeriod": 60,
- "answeredCallsForPeriod": 41,
- "totalCallsLast24h": 50,
- "droppedCallsLast24h": 4,
- "answeredCallsLast24h": 38,
- "current-agent-presence": [
- {
- "name": "Available",
- "count": 1
}
]
}
]
}The Billing API is used to manage billing ids for organizations.
Use the Billing API to:
- Get billing ranges for an organization
- Get the default billing id for an organization
- Update billing ranges for an organization
- Update the default billing id for an organization
Get billing ranges
Retrieve billing ranges for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "billingRanges": [
- {
- "first": "11",
- "last": "38",
- "length": 2,
- "prefix": "+468322322",
- "sourceTags": "tag1,tag2"
}
]
}Update billing ranges
If billing ranges have been defined, only billing ids within these ranges are allowed to be used. Billing ranges are not allowed to overlap within the organization. All numbers outside the set billing ranges will be removed.
Caution!
If you do not supply any numbers then all numbers will be removed. No numbers are removed if an error occurs.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
Array of objects (BillingRangeDTO) |
Responses
Request samples
- Payload
{- "billingRanges": [
- {
- "first": "11",
- "last": "38",
- "length": 2,
- "prefix": "+468322322",
- "sourceTags": "tag1,tag2"
}
]
}Get billing ranges Deprecated
Retrieve billing ranges for an organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "billingRanges": [
- {
- "first": "11",
- "last": "38",
- "length": 2,
- "prefix": "+468322322",
- "sourceTags": "tag1,tag2"
}
]
}Update billing ranges Deprecated
If billing ranges have been defined, only billing ids within these ranges are allowed to be used. Billing ranges are not allowed to overlap within the organization. All numbers outside the set billing ranges will be removed.
Caution!
If you supply no numbers then all numbers will be removed. No numbers are removed if an error occur.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
Array of objects (BillingRangeDTO) |
Responses
Request samples
- Payload
{- "billingRanges": [
- {
- "first": "11",
- "last": "38",
- "length": 2,
- "prefix": "+468322322",
- "sourceTags": "tag1,tag2"
}
]
}Update default billing id
Update default billing id for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| billingId required | string The default billing id used in the organization. Must be a global phone number. |
| sourceTags | string A comma-separated list of source tags. |
Responses
Request samples
- Payload
{- "billingId": "+46832232211",
- "sourceTags": "tag1,tag2"
}Get default billing information Deprecated
Retrieve the default billing information for an organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "billingId": "+46832232211",
- "sourceTags": "tag1,tag2"
}Update default billing id Deprecated
Update the default billing id used in the organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| billingId required | string The default billing id used in the organization. Must be a global phone number. |
| sourceTags | string A comma-separated list of source tags. |
Responses
Request samples
- Payload
{- "billingId": "+46832232211",
- "sourceTags": "tag1,tag2"
}The CDR API is used to read CDRs and manage the CDR webhook registrations.
The API supports both polling using http GET, or registering webhooks for listening on event changes.
Use the CDR API to:
- Get CDRs generate during a specific time span from an organization
- Register a CDR web hook for an organization
- Get a registered CDR web hook
- Get all registered CDR web hooks for an organization
- Update a registered CDR web hook
- Delete a registered CDR web hook
Register webhook
Register a new webhook for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| ongoing required | boolean Indicates if the target wants to receive ongoing or only completed CDRs |
| public required | boolean Indicates if the target node hosting the webhook is deployed on the same network segment as the service nodes or needs to go through the edge http proxy |
| target_url required | string The webhook url |
| type required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type that the webhook subscribes for |
Responses
Callbacks
Request samples
- Payload
{- "type": "CALL",
- "ongoing": true,
- "public": true
}Response samples
- 200
- 400
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}List webhooks Deprecated
Fetch a list of registered webhooks.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "cdr-hook": [
- {
- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}
]
}Register webhook Deprecated
Register a new webhook for an organization
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| ongoing required | boolean Indicates if the target wants to receive ongoing or only completed CDRs |
| public required | boolean Indicates if the target node hosting the webhook is deployed on the same network segment as the service nodes or needs to go through the edge http proxy |
| target_url required | string The webhook url |
| type required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type that the webhook subscribes for |
Responses
Request samples
- Payload
{- "type": "CALL",
- "ongoing": true,
- "public": true
}Response samples
- 200
- 400
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}Get webhook
Retrieve a webhook registered for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the webhook |
Responses
Response samples
- 200
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}Update webhook
Update an existing webhook.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the webhook |
Request Body schema: application/json
| ongoing required | boolean Indicates if the target wants to receive ongoing or only completed CDRs |
| public required | boolean Indicates if the target node hosting the webhook is deployed on the same network segment as the service nodes or needs to go through the edge http proxy |
| target_url required | string The webhook url |
| type required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type that the webhook subscribes for |
Responses
Callbacks
Request samples
- Payload
{- "type": "CALL",
- "ongoing": true,
- "public": true
}Response samples
- 200
- 400
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}Get webhook Deprecated
Retrieve a webhook registered for an organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the webhook |
Responses
Response samples
- 200
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}Update webhook Deprecated
Update an existing webhook.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the webhook |
Request Body schema: application/json
| ongoing required | boolean Indicates if the target wants to receive ongoing or only completed CDRs |
| public required | boolean Indicates if the target node hosting the webhook is deployed on the same network segment as the service nodes or needs to go through the edge http proxy |
| target_url required | string The webhook url |
| type required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type that the webhook subscribes for |
Responses
Request samples
- Payload
{- "type": "CALL",
- "ongoing": true,
- "public": true
}Response samples
- 200
- 400
{- "id": 434356,
- "type": "CALL",
- "ongoing": true,
- "public": true
}Get CDRs
Retrieves CDRs in CSV format.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch CDRs |
| cdrType required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type |
query Parameters
| spanStart | integer <int64> Default: 0 The start of the time span in UTC milliseconds (Epoch time) |
| spanEnd | integer <int64> The end of the time span in UTC milliseconds (Epoch time) |
| download | boolean Default: false Set to 'true' to download the file as a Content-Disposition attachement |
Responses
Get CDRs Deprecated
Retrieves CDRs in CSV format.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch CDRs |
| cdrType required | string Enum: "CALL" "IM" "SMS" "VOICE_QUALITY" "QUEUESTATS" "REGISTRATION" "AGENT" The CDR type |
query Parameters
| spanStart | integer <int64> Default: 0 The start of the time span in UTC milliseconds (Epoch time) |
| spanEnd | integer <int64> The end of the time span in UTC milliseconds (Epoch time) |
| download | boolean Default: false Set to 'true' to download the file as a Content-Disposition attachement |
Responses
The The Call Recording Settings API is used to manage call recording service settings.
The Call Recording Settings API to:
- Update call recording settings on organization level
- Update call recording settings on user group level
- Get call recording settings on organization level
- Get call recording settings on user group level
- Delete call recording settings on organization level
- Delete call recording settings on user group level
- Update the service priority between the user group settings
- Get the service priority between the user group settings
Get user group settings
Retrieves call recording settings for a user group.
Authorizations:
path Parameters
| domain required | string The organization domain |
| groupId required | string The user group name |
Responses
Response samples
- 200
{- "scope": "ALL_CALLS",
- "terminateOnError": true,
- "randomize": 50,
- "userPromptForInboundInternalCalls": "system_silence",
- "userPromptForInboundExternalCalls": "system_silence",
- "userPromptForOutboundInternalCalls": "system_silence",
- "userPromptForOutboundExternalCalls": "system_silence",
- "counterpartPromptForInboundInternalCalls": "system_silence",
- "counterpartPromptForInboundExternalCalls": "system_silence",
- "counterpartPromptForOutboundInternalCalls": "system_silence",
- "counterpartPromptForOutboundExternalCalls": "system_silence",
- "showRecordingInformation": true,
- "allowPauseResume": true,
- "serverGroup": "2",
- "recordEmergencyCalls": true,
- "requireConsent": true,
- "consentPrompt": "system_recording_consent",
- "maxInboxSize": 10,
- "maxLengthOfRecording": 300,
- "fileAttached": false,
- "emailNotification": false,
- "serverType": "UC_ANALYTICS"
}Update user group settings
Update call recording settings for a user group.
Authorizations:
path Parameters
| domain required | string The organization domain |
| groupId required | string The user group name |
Request Body schema: application/json
| scope | string Enum: "EMPTY" "ALL_CALLS" "ON_DEMAND" "EXTERNAL_CALLS" "INTERNAL_CALLS" "NO_CALLS" Which calls that should be recorded. Note that some options have additional license requirements. This setting is not applicable for PERSONAL call recording. |
| terminateOnError | boolean Whether calls should be terminated if recording fails. This setting is not applicable for PERSONAL call recording. |
| randomize | integer <int32> [ 1 .. 99 ] The percentage of calls that should be recorded (not applicable for ON_DEMAND recording). This setting is not applicable for PERSONAL call recording. |
| userPromptForInboundInternalCalls | string Prompt to play for the user when an inbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForInboundExternalCalls | string Prompt to play for the user when an inbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForOutboundInternalCalls | string Prompt to play for the user when an outbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForOutboundExternalCalls | string Prompt to play for the user when an outbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForInboundInternalCalls | string Prompt to play for the other party when an inbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForInboundExternalCalls | string Prompt to play for the other party when an inbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForOutboundInternalCalls | string Prompt to play for the other party when an outbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForOutboundExternalCalls | string Prompt to play for the other party when an outbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| showRecordingInformation | boolean Whether call recording information should be shown for users. This setting is not applicable for PERSONAL call recording. |
| allowPauseResume | boolean Whether to allow users to pause/resume call recordings. This setting is not applicable for PERSONAL call recording. |
| serverGroup | string The Id of the call recording server group to use. The group must belong to the same reseller as the organization or be available for all resellers. If not set, the default group will be used. |
| recordEmergencyCalls | boolean Whether emergency calls should be recorded or not. |
| requireConsent | boolean Should a caller be allowed to press 1 to consent to being recorded or 0 to reject the reocrding. Only applicable for external inbound calls. |
| consentPrompt | string Prompt to play when asking the caller to consent to the call being recorded. |
| maxInboxSize | integer <int32> [ 1 .. 1000 ] Specifies how much recording storage is available to a user (in megabytes). This setting is only applicable for PERSONAL call recording. |
| maxLengthOfRecording | integer <int32> [ 1 .. 60000 ] Specifies the maximum length of a recording (in seconds). This setting is only applicable for PERSONAL call recording. |
| fileAttached | boolean Specifies if new recordings voice files should be attached to emails when email notification is enabled. This setting is only applicable for PERSONAL call recording. |
| emailNotification | boolean Specifies if new recordings should be notified to the user's email. This setting is only applicable for PERSONAL call recording. |
| serverType | string Enum: "EMPTY" "UC_ANALYTICS" "GENERIC" "PERSONAL" What type of call recording should be used. If more than one type is supported in the organization, then this value is mandatory. |
Responses
Request samples
- Payload
{- "scope": "ALL_CALLS",
- "terminateOnError": true,
- "randomize": 50,
- "userPromptForInboundInternalCalls": "system_silence",
- "userPromptForInboundExternalCalls": "system_silence",
- "userPromptForOutboundInternalCalls": "system_silence",
- "userPromptForOutboundExternalCalls": "system_silence",
- "counterpartPromptForInboundInternalCalls": "system_silence",
- "counterpartPromptForInboundExternalCalls": "system_silence",
- "counterpartPromptForOutboundInternalCalls": "system_silence",
- "counterpartPromptForOutboundExternalCalls": "system_silence",
- "showRecordingInformation": true,
- "allowPauseResume": true,
- "serverGroup": "2",
- "recordEmergencyCalls": true,
- "requireConsent": true,
- "consentPrompt": "system_recording_consent",
- "maxInboxSize": 10,
- "maxLengthOfRecording": 300,
- "fileAttached": false,
- "emailNotification": false,
- "serverType": "UC_ANALYTICS"
}Get organization settings
Retrieves call recording settings for an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "scope": "ALL_CALLS",
- "terminateOnError": true,
- "randomize": 50,
- "userPromptForInboundInternalCalls": "system_silence",
- "userPromptForInboundExternalCalls": "system_silence",
- "userPromptForOutboundInternalCalls": "system_silence",
- "userPromptForOutboundExternalCalls": "system_silence",
- "counterpartPromptForInboundInternalCalls": "system_silence",
- "counterpartPromptForInboundExternalCalls": "system_silence",
- "counterpartPromptForOutboundInternalCalls": "system_silence",
- "counterpartPromptForOutboundExternalCalls": "system_silence",
- "showRecordingInformation": true,
- "allowPauseResume": true,
- "serverGroup": "2",
- "recordEmergencyCalls": true,
- "requireConsent": true,
- "consentPrompt": "system_recording_consent",
- "maxInboxSize": 10,
- "maxLengthOfRecording": 300,
- "fileAttached": false,
- "emailNotification": false,
- "serverType": "UC_ANALYTICS"
}Update organization settings
Update call recording settings for an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/json
| scope | string Enum: "EMPTY" "ALL_CALLS" "ON_DEMAND" "EXTERNAL_CALLS" "INTERNAL_CALLS" "NO_CALLS" Which calls that should be recorded. Note that some options have additional license requirements. This setting is not applicable for PERSONAL call recording. |
| terminateOnError | boolean Whether calls should be terminated if recording fails. This setting is not applicable for PERSONAL call recording. |
| randomize | integer <int32> [ 1 .. 99 ] The percentage of calls that should be recorded (not applicable for ON_DEMAND recording). This setting is not applicable for PERSONAL call recording. |
| userPromptForInboundInternalCalls | string Prompt to play for the user when an inbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForInboundExternalCalls | string Prompt to play for the user when an inbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForOutboundInternalCalls | string Prompt to play for the user when an outbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| userPromptForOutboundExternalCalls | string Prompt to play for the user when an outbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForInboundInternalCalls | string Prompt to play for the other party when an inbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForInboundExternalCalls | string Prompt to play for the other party when an inbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForOutboundInternalCalls | string Prompt to play for the other party when an outbound internal call is recorded. This setting is not applicable for PERSONAL call recording. |
| counterpartPromptForOutboundExternalCalls | string Prompt to play for the other party when an outbound external call is recorded. This setting is not applicable for PERSONAL call recording. |
| showRecordingInformation | boolean Whether call recording information should be shown for users. This setting is not applicable for PERSONAL call recording. |
| allowPauseResume | boolean Whether to allow users to pause/resume call recordings. This setting is not applicable for PERSONAL call recording. |
| serverGroup | string The Id of the call recording server group to use. The group must belong to the same reseller as the organization or be available for all resellers. If not set, the default group will be used. |
| recordEmergencyCalls | boolean Whether emergency calls should be recorded or not. |
| requireConsent | boolean Should a caller be allowed to press 1 to consent to being recorded or 0 to reject the reocrding. Only applicable for external inbound calls. |
| consentPrompt | string Prompt to play when asking the caller to consent to the call being recorded. |
| maxInboxSize | integer <int32> [ 1 .. 1000 ] Specifies how much recording storage is available to a user (in megabytes). This setting is only applicable for PERSONAL call recording. |
| maxLengthOfRecording | integer <int32> [ 1 .. 60000 ] Specifies the maximum length of a recording (in seconds). This setting is only applicable for PERSONAL call recording. |
| fileAttached | boolean Specifies if new recordings voice files should be attached to emails when email notification is enabled. This setting is only applicable for PERSONAL call recording. |
| emailNotification | boolean Specifies if new recordings should be notified to the user's email. This setting is only applicable for PERSONAL call recording. |
| serverType | string Enum: "EMPTY" "UC_ANALYTICS" "GENERIC" "PERSONAL" What type of call recording should be used. If more than one type is supported in the organization, then this value is mandatory. |
Responses
Request samples
- Payload
{- "scope": "ALL_CALLS",
- "terminateOnError": true,
- "randomize": 50,
- "userPromptForInboundInternalCalls": "system_silence",
- "userPromptForInboundExternalCalls": "system_silence",
- "userPromptForOutboundInternalCalls": "system_silence",
- "userPromptForOutboundExternalCalls": "system_silence",
- "counterpartPromptForInboundInternalCalls": "system_silence",
- "counterpartPromptForInboundExternalCalls": "system_silence",
- "counterpartPromptForOutboundInternalCalls": "system_silence",
- "counterpartPromptForOutboundExternalCalls": "system_silence",
- "showRecordingInformation": true,
- "allowPauseResume": true,
- "serverGroup": "2",
- "recordEmergencyCalls": true,
- "requireConsent": true,
- "consentPrompt": "system_recording_consent",
- "maxInboxSize": 10,
- "maxLengthOfRecording": 300,
- "fileAttached": false,
- "emailNotification": false,
- "serverType": "UC_ANALYTICS"
}Update group priority
Updates the call recording service group priority.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/json
| groups | Array of strings User groups. The groups are listed in the priority order. |
Responses
Request samples
- Payload
{- "groups": "sales"
}The Call Routing Settings API is a group of methods to manage call routing settings for an organization
Use the Call Routing Settings API to:
- Get settings for Call Routing
- Update settings for Call Routing
Get general settings Deprecated
Read general settings of call routing rule.
NOTE: This method is DEPRECATED since 5.4.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "fallbackTimeout": 20
}Update general settings Deprecated
Update general settings of call routing rule.
NOTE: This method is DEPRECATED since 5.4.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: required
| fallbackTimeout | integer <int32> Default: 30 Enum: 20 30 45 60 90 Decides the time period in seconds to trigger fallback rule on no answer |
Responses
Request samples
- Payload
{- "fallbackTimeout": 20
}Update general settings
Update general settings of call routing rule.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/jsonrequired
| fallbackTimeout | integer <int32> Default: 30 Enum: 20 30 45 60 90 Decides the time period in seconds to trigger fallback rule on no answer |
Responses
Request samples
- Payload
{- "fallbackTimeout": 20
}The Line State API is used to manage a user's line state.
Use the Line State API to:
- Get line state
- Update line state
- Create line state
- Delete line state
Get line state
Fetches a specific line state for a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| externalId required | string The external ID |
Responses
Response samples
- 200
{- "expiresOn": "2020-03-10T11:05:00+01"
}Update line state
Updates a line state for a user and external ID. If there is no current line state, it will be created.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| externalId required | string The external ID |
Responses
Response samples
- 200
{- "expiresOn": "2020-03-10T11:05:00+01"
}Create line state
Creates a line state for a user and external id. If the line state already exists, it will be updated.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| externalId required | string The external ID |
Responses
Response samples
- 200
{- "expiresOn": "2020-03-10T11:05:00+01"
}Delete line state
Removes a specific line state for a user.
Type of call is not considered, i.e. eventual resting time for an agent will not be taken into account when removing the line state.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| externalId required | string The external ID |
Responses
The Communication History API is used to read all available group inbox messages
Use the Communication History API to:
- Get the group inbox history items
Get group inbox items
Retrieves the admin group inbox history items for an entire organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
This example details the response with one Group Inbox History Item in the Communication History API response.
{- "historyItems": [
- {
- ".GroupInboxVoiceMailDTO": {
- "itemId": 370,
- "startTime": "2020-01-30T17:11:13Z",
- "remoteParty": {
- "contactId": "jane.doe@example.com",
- "number": "+1555123001",
- "displayName": "Jane Doe"
}, - "itemType": "VOICEMAIL",
- "isSeen": true,
- "callItemId": 0,
- "isPlayed": false,
- "inboxName": "Group Inbox 1"
}
}
], - "flushCache": true,
- "generatedAt": "2020-01-31T09:28:21Z",
- "hintCount": 1
}The Missed Call Notification Settings API has a group of methods to manage missed call notifications
Use the Missed Call Notification API to:
- Get missed calls notification setting for an organization
- Get missed calls notification setting for a user group
- Get missed calls notification setting for a user
- Get missed calls service group priority order
- Update missed calls notification setting for an organization
- Update missed calls notification setting for a user group
- Update missed calls notification setting for a user
- Update missed calls service group priority order
- Delete missed calls notification setting for an organization (make it empty/unset)
- Delete missed calls notification setting for a user group (make it empty/unset)
- Delete missed calls notification setting for a user (make it empty/unset)
Get user group level settings
Retrieve missed calls notification setting for a user group
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Responses
Response samples
- 200
{- "active": true
}Update user group level settings
Update missed calls notification setting for a user group
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Request Body schema: application/json
| active | boolean Indicates whether notification of missed call is activated (on current level) or not, true/false or empty. |
Responses
Request samples
- Payload
{- "active": true
}Update organization level settings
Update missed calls notification setting for an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| active | boolean Indicates whether notification of missed call is activated (on current level) or not, true/false or empty. |
Responses
Request samples
- Payload
{- "active": true
}Update user level settings
Update missed calls notification setting for a user
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Request Body schema: application/json
| active | boolean Indicates whether notification of missed call is activated (on current level) or not, true/false or empty. |
Responses
Request samples
- Payload
{- "active": true
}Update service group priority order
Update missed calls service group priority order
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| groups | Array of strings User groups. The groups are listed in the priority order. |
Responses
Request samples
- Payload
{- "groups": [
- "sales",
- "support",
- "marketing"
]
}The Conference Settings API is used to manage settings for conference calls for organizations.
Use the Conference Settings API to:
- Get conference settings service group priority
- Update conference settings service group priority
- Get conference settings for an organization
- Update conference settings for an organization
- Delete conference settings for an organization
- Get conference settings for a user group
- Update conference settings for a user group
- Delete conference settings for a user group
- Get conference settings for a user
- Update conference settings for a user
- Delete conference settings for a user
Get user group level settings
Read conference settings for a user group
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Responses
Response samples
- 200
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Update user group level settings
Update conference settings for a user group
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Request Body schema: application/json
| firstParticipantPrompt | string Prompt for the first participant |
| additionalParticipantsPrompt | string Prompt for additional participants |
Responses
Request samples
- Payload
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Get organization level settings
Read conference settings for an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Update organization level settings
Update conference settings for an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| firstParticipantPrompt | string Prompt for the first participant |
| additionalParticipantsPrompt | string Prompt for additional participants |
Responses
Request samples
- Payload
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Get user level settings
Read conference settings for a user
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Responses
Response samples
- 200
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Update user level settings
Update conference settings for a user
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Request Body schema: application/json
| firstParticipantPrompt | string Prompt for the first participant |
| additionalParticipantsPrompt | string Prompt for additional participants |
Responses
Request samples
- Payload
{- "firstParticipantPrompt": "system_silence",
- "additionalParticipantsPrompt": "system_silence"
}Update service group priority
Update conference settings service group priority
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: */*required
| groups | Array of strings User groups. The groups are listed in the priority order. |
Responses
Request samples
- Payload
{ "groups": [ "sales", "support", "marketing" ] }
The Contacts Information V1 API has a set of commands to get more information and manipulate individual contacts. This is based on the presence authorization in Dstny Core. Contact management is authenticated using API tickets for Contact search.
Use the Contacts Information V1 API to:
- Get contact's presence role
- Set contact's presence role
- Subscribe on contact's linestate
- Subscribe on contact's presence
The Device Configuration API is used to administer managed deskphone SIP devices (e.g. Snom or Mitel deskphones). The API is authenticated using API tickets for Device configuration.
This API is also used to assign users to SIP devices. This is done by configuring the primary line of the SIP phone as a line for the applicable user.
Use the Device Configuration API to:
- Get provisioning URL
- Get supported SIP phone models
- Get all SIP devices of supported type
- Get the configuration of a SIP device
- Update the configuration of a SIP device
- Create new SIP device
- Delete SIP device
Get device configuration
Gets details of the SIP device specified by the organization domain and the MAC id.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
Responses
Response samples
- 200
A Poly VVX 350 SIP phone assigned to Alice, with an extension key to Bob
{- "id": "123123123789",
- "type": "polyvvx",
- "model": "polyVVX350",
- "modelname": "Poly VVX 350",
- "ip": "10.10.10.10",
- "firmware": "6.5.5",
- "description": "Alice's phone",
- "mode": "standard",
- "user": "alice@example.com",
- "username": "Alice Alisson",
- "registered": true,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G711_Mu",
- "prio": 1
}, - {
- "name": "G722",
- "prio": 2
}
]
}, - "keys": {
- "key": [
- {
- "category": "main_line",
- "index": 1,
- "type": "line",
- "value": "alice@example.com"
}, - {
- "category": "line_key",
- "index": 3,
- "type": "extension",
- "value": "bob@example.com",
- "label": "Bob Bobson",
- "defaultLabel": true
}
]
}
}Update device configuration
Updates the configuration of an existing SIP device.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
query Parameters
| reload | string If true, the device will be asked to reload it's configuration. This may cause the phone to restart. |
Request Body schema: application/jsonrequired
| id | string The MAC address of the SIP device. Read-only. |
| type | string Enum: "snom" "mitel" "miteldect" "polyvvx" "yealink" The type of device. Read-only. |
| model | string The model ID of the device. Required for POST requests, ignored in PUT requests. |
| modelname | string The display name of the model of the device. Read-only. |
| ip | string The IP address of the SIP device. Read-only. |
| deviceLocation | string The location of this device. If not stated, the default location will be used. |
| firmware | string The firmware version of the SIP device. Read-only. |
| firmwareUrlName | string The name of the firmware URL applicable for this device. If not stated, the default firmware URL will be used. |
| toneScheme | string The ID of the tone scheme configured for this device. If not stated, the default tone scheme will be used. |
| description | string A description of the device. |
| mode | string Enum: "standard" "freeseating" The mainline mode of the SIP device. There are two alternatives: |
| user | string The assigned or seated user of the device, in the form userid@domain. Read-only. |
| username | string The display name of the assigned or seated user. Read-only. |
| registered | boolean True if the device has an active registration with the SIP server. Read-only. |
object (codecPrios) A list of prioritized codecs | |
object (VLanDTO) The VLAN settings configured for this device. If not stated, VLAN is disabled. At PUT/POST, if VLAN is not provided, current configuration is not changed. If a VLAN without content is provided, the current configuration is removed. | |
object (DeviceKeysDTO) Configured keys of this device. | |
object (DeviceAttributesDTO) Configured attributes of this device. | |
object (DeviceExpansionModulesDTO) Configured expansion modules of this device. If not provided at PUT, the currently configured modules will remain. |
Responses
Request samples
- Payload
A Poly VVX 350 SIP phone assigned to Alice, with an extension key to Bob
{- "id": "123123123789",
- "type": "polyvvx",
- "model": "polyVVX350",
- "modelname": "Poly VVX 350",
- "ip": "10.10.10.10",
- "firmware": "6.5.5",
- "description": "Alice's phone",
- "mode": "standard",
- "user": "alice@example.com",
- "username": "Alice Alisson",
- "registered": true,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G711_Mu",
- "prio": 1
}, - {
- "name": "G722",
- "prio": 2
}
]
}, - "keys": {
- "key": [
- {
- "category": "main_line",
- "index": 1,
- "type": "line",
- "value": "alice@example.com"
}, - {
- "category": "line_key",
- "index": 3,
- "type": "extension",
- "value": "bob@example.com",
- "label": "Bob Bobson",
- "defaultLabel": true
}
]
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create device configuration
Creates a new SIP device.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
Request Body schema: application/jsonrequired
| id | string The MAC address of the SIP device. Read-only. |
| type | string Enum: "snom" "mitel" "miteldect" "polyvvx" "yealink" The type of device. Read-only. |
| model | string The model ID of the device. Required for POST requests, ignored in PUT requests. |
| modelname | string The display name of the model of the device. Read-only. |
| ip | string The IP address of the SIP device. Read-only. |
| deviceLocation | string The location of this device. If not stated, the default location will be used. |
| firmware | string The firmware version of the SIP device. Read-only. |
| firmwareUrlName | string The name of the firmware URL applicable for this device. If not stated, the default firmware URL will be used. |
| toneScheme | string The ID of the tone scheme configured for this device. If not stated, the default tone scheme will be used. |
| description | string A description of the device. |
| mode | string Enum: "standard" "freeseating" The mainline mode of the SIP device. There are two alternatives: |
| user | string The assigned or seated user of the device, in the form userid@domain. Read-only. |
| username | string The display name of the assigned or seated user. Read-only. |
| registered | boolean True if the device has an active registration with the SIP server. Read-only. |
object (codecPrios) A list of prioritized codecs | |
object (VLanDTO) The VLAN settings configured for this device. If not stated, VLAN is disabled. At PUT/POST, if VLAN is not provided, current configuration is not changed. If a VLAN without content is provided, the current configuration is removed. | |
object (DeviceKeysDTO) Configured keys of this device. | |
object (DeviceAttributesDTO) Configured attributes of this device. | |
object (DeviceExpansionModulesDTO) Configured expansion modules of this device. If not provided at PUT, the currently configured modules will remain. |
Responses
Request samples
- Payload
A Poly VVX 350 SIP phone assigned to Alice, with an extension key to Bob
{- "id": "123123123789",
- "type": "polyvvx",
- "model": "polyVVX350",
- "modelname": "Poly VVX 350",
- "ip": "10.10.10.10",
- "firmware": "6.5.5",
- "description": "Alice's phone",
- "mode": "standard",
- "user": "alice@example.com",
- "username": "Alice Alisson",
- "registered": true,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G711_Mu",
- "prio": 1
}, - {
- "name": "G722",
- "prio": 2
}
]
}, - "keys": {
- "key": [
- {
- "category": "main_line",
- "index": 1,
- "type": "line",
- "value": "alice@example.com"
}, - {
- "category": "line_key",
- "index": 3,
- "type": "extension",
- "value": "bob@example.com",
- "label": "Bob Bobson",
- "defaultLabel": true
}
]
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get device configuration Deprecated
Gets details of the SIP desk phone specified by the organization domain and the MAC id.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
Responses
Response samples
- 200
- 400
- 404
{- "mac": "00085A389166",
- "userName": "john.smith@example.com",
- "user": "John Smith",
- "type": "mitel6867i",
- "description": "10.11.12.14",
- "deviceLocation": "default location",
- "toneScheme": "Europe",
- "firmwareRepository": "default_test_68xx",
- "vlanId": "75",
- "vlanPriority": "2",
- "freeSeating": false,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G.711u",
- "prio": 1
}
]
}, - "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}, - "expansionModule": false,
- "expansionModules": {
- "expansionModule": [
- {
- "type": "M680i",
- "priority": 2,
- "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}
}
]
}, - "firmwareVersion": "5.0.0.2018",
- "ipAdress": "10.11.12.13",
- "state": "User assigned",
- "registered": false,
- "syslogServer": "10.11.12.13:515",
- "logLevel": 1
}Update device configuration Deprecated
Updates the configuration of an existing SIP device. Note: Refer to the POST method for details of request body and possible error messages.
Make sure 'type' is not changed by mistake.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
query Parameters
| reset | string True - triggers the phone to restart (and fetch new configuration). Default to false. |
| reload | string True - triggers device to fetch new configuration. Default to false. |
Request Body schema:
| type required | string The type of the SIP device. This must be a supported SIP phone model of type mitel or snom. For supported models, see the GET request for supported devices. Note that the model of existing devices can not be modified. |
| mac | string The MAC address of the phone. Mandatory for PUT/POST. |
| description | string A description of the device. |
| deviceLocation | string The location of the device. If omitted, the default location is used. |
| toneScheme | string The tone scheme for the phone as defined on the management node. If omitted, the system default is used. |
| firmwareRepository | string The name of the firmware repository as defined on the management node. If omitted, the system default is used. |
| vlanId | string Optionally, the VLan ID of the device. |
| vlanPriority | string Optionally, the VLan priority. |
| freeSeating | boolean Whether or not the phone is in free seating mode. |
object (codecPrios) A list of prioritized codecs | |
object (functionKeys) A collection of function keys. | |
| expansionModule | boolean Whether or not the phone has expansion modules. Applicable for snom phones. |
object (expansionModules) A collection of expansion modules. Applicable for mitel phones. | |
| firmwareVersion | string The firmware version of the device. |
| ipAdress | string The IP address of the device. |
| syslogServer | string The IP address of the syslog server to which syslog from this phone will be sent. Optionally, a port number can be appended to the IP address. If a port number is omitted, the default port is 514. |
| logLevel | integer <int32> [ 0 .. 6 ] The debug log level of the device. 0 means logging is turned off. The default, 1, means that errors are logged. |
Responses
Request samples
- Payload
{- "mac": "00085A389166",
- "type": "mitel6867i",
- "description": "10.11.12.14",
- "deviceLocation": "default location",
- "toneScheme": "Europe",
- "firmwareRepository": "default_test_68xx",
- "vlanId": "75",
- "vlanPriority": "2",
- "freeSeating": false,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G.711u",
- "prio": 1
}
]
}, - "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}, - "expansionModule": false,
- "expansionModules": {
- "expansionModule": [
- {
- "type": "M680i",
- "priority": 2,
- "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}
}
]
}, - "firmwareVersion": "5.0.0.2018",
- "ipAdress": "10.11.12.13",
- "syslogServer": "10.11.12.13:515",
- "logLevel": 1
}Response samples
- 400
- 404
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create device configuration Deprecated
If the device already exists, the configuration is overwritten. For allowable values of certain field, e.g. the category or type of a function key, refer to the definition of the request body model.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| mac required | string The MAC address of the device. |
query Parameters
| reset | string True - triggers the phone to restart (and fetch new configuration). Default to false. |
| reload | string True - triggers device to fetch new configuration. Default to false. |
Request Body schema:
| type required | string The type of the SIP device. This must be a supported SIP phone model of type mitel or snom. For supported models, see the GET request for supported devices. Note that the model of existing devices can not be modified. |
| mac | string The MAC address of the phone. Mandatory for PUT/POST. |
| description | string A description of the device. |
| deviceLocation | string The location of the device. If omitted, the default location is used. |
| toneScheme | string The tone scheme for the phone as defined on the management node. If omitted, the system default is used. |
| firmwareRepository | string The name of the firmware repository as defined on the management node. If omitted, the system default is used. |
| vlanId | string Optionally, the VLan ID of the device. |
| vlanPriority | string Optionally, the VLan priority. |
| freeSeating | boolean Whether or not the phone is in free seating mode. |
object (codecPrios) A list of prioritized codecs | |
object (functionKeys) A collection of function keys. | |
| expansionModule | boolean Whether or not the phone has expansion modules. Applicable for snom phones. |
object (expansionModules) A collection of expansion modules. Applicable for mitel phones. | |
| firmwareVersion | string The firmware version of the device. |
| ipAdress | string The IP address of the device. |
| syslogServer | string The IP address of the syslog server to which syslog from this phone will be sent. Optionally, a port number can be appended to the IP address. If a port number is omitted, the default port is 514. |
| logLevel | integer <int32> [ 0 .. 6 ] The debug log level of the device. 0 means logging is turned off. The default, 1, means that errors are logged. |
Responses
Request samples
- Payload
{- "mac": "00085A389166",
- "type": "mitel6867i",
- "description": "10.11.12.14",
- "deviceLocation": "default location",
- "toneScheme": "Europe",
- "firmwareRepository": "default_test_68xx",
- "vlanId": "75",
- "vlanPriority": "2",
- "freeSeating": false,
- "codecPrios": {
- "codecPrio": [
- {
- "name": "G.711u",
- "prio": 1
}
]
}, - "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}, - "expansionModule": false,
- "expansionModules": {
- "expansionModule": [
- {
- "type": "M680i",
- "priority": 2,
- "functionKeys": {
- "functionKey": [
- {
- "category": "TOP_SOFT_KEY",
- "key": 2,
- "type": "DIRECTORY_SEARCH",
- "value": "jane.doe@example.com",
- "label": "Search..."
}
]
}
}
]
}, - "firmwareVersion": "5.0.0.2018",
- "ipAdress": "10.11.12.13",
- "syslogServer": "10.11.12.13:515",
- "logLevel": 1
}Response samples
- 400
- 404
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List devices with paging
Get an ordered and paged list of managed deskphone SIP devices in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
query Parameters
| page | integer <int32> The sequence number of the page to get. Must be a positive integer. Default is 1 (first page). |
| pagesize | integer <int32> The number of items on each page. Must be an integer in the range 1-200. Default is 20. |
| orderby | Array of strings Items Enum: "id_asc" "id_desc" "type_asc" "type_desc" "model_asc" "model_desc" "modelname_asc" "modelname_desc" "ip_asc" "ip_desc" "firmware_asc" "firmware_desc" "description_asc" "description_desc" "mode_asc" "mode_desc" "user_asc" "user_desc" "username_asc" "username_desc" "registered_asc" "registered_desc" An array of expressions that specify how the items should be ordered. Each expression is comprised by the field to order by and the direction of the sort (ascending or descending). The default order is by id ascending. It will be used if no expression is stated, and as a last resort when other expressions are not sufficient. |
Responses
Response samples
- 200
- 400
A set of 5 SIP devices divided in 3 pages
{- "scope": {
- "page": 1,
- "pagesize": 2,
- "totalpages": 3,
- "totalitems": 5,
- "sorting": [
- {
- "by": "id",
- "order": "ascending"
}
]
}, - "devices": [
- {
- "id": "123123123123",
- "type": "mitel",
- "model": "mitel6867i",
- "modelname": "Mitel 6867i",
- "ip": "10.10.10.10",
- "firmware": "6.0.3",
- "description": "Alice's phone",
- "mode": "standard",
- "user": "alice@example.com",
- "username": "Alice Alisson",
- "registered": true
}, - {
- "id": "123123123456",
- "type": "snom",
- "model": "snom712",
- "modelname": "Snom 712",
- "ip": "10.10.10.10",
- "firmware": "17.0.10",
- "description": "Bob's phone",
- "mode": "freeseating",
- "user": "bob@example.com",
- "username": "Bob Bobson",
- "registered": true
}
]
}Get supported devices Deprecated
Fetches the supported SIP phone models of the provided type.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| type required | string The phone type. |
Responses
Response samples
- 200
- 400
{- "model": [
- "mitel6865i",
- "mitel6920"
]
}Get provisioning URL Deprecated
Fetches the provisioning URL that the SIP device should use.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| type required | string The phone type. |
Responses
Response samples
- 200
- 400
{- "type": "mitel6865i",
}List devices Deprecated
Retrieve a list of the SIP desk phones specified by the organization domain.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
Responses
Response samples
- 200
{- "device": [
- {
- "mac": "00085A389166",
- "type": "mitel6867i",
- "description": "meeting room 1"
}
]
}The Device Specification API is used to read specifications of managed SIP devices. The API is authenticated using API tickets for Device configuration.
Use the Device Specification API to:
- Get supported SIP phone models
- Get supported expansion modules
- Get provisioning URL
- Get available firmware repositories
- Get available tone schemes
- Get details of available attributes for a SIP phone model
- Get the capabilities of a SIP phone model
- Get allowed values for a key option parameter
Get attributes
Get details of available attributes for the stated domain and device model.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| model required | string The model of the device |
query Parameters
| languageId | string The language to get labels and descriptions in. Stated as a ISO 639-1 language code (e.g. 'sv' for Swedish) optionally combined with an ISO-3166-2 Country code (e.g. 'en_US' for US English). If not provided, the locale of the calling context is used. |
| mainlineUser | string The userId of the seated or assigned user. The default value specifics for some attributes may vary depending on this. |
Responses
Response samples
- 200
- 400
Sample attributes for Mitel 6867i phones with labels and descriptions in English
{- "model": "mitel6867i",
- "attributes": [
- {
- "id": "logLevel",
- "type": "selectionType",
- "validation": {
- "required": true,
- "allowedValues": [
- "OFF",
- "FATAL",
- "ERROR",
- "WARNING",
- "INFO",
- "TRANSPORT",
- "DEBUG",
- "ALL"
]
}, - "default": {
- "value": "OFF"
}, - "label": "Log level",
- "description": "General log level for the device. "
}, - {
- "id": "missedCalls",
- "type": "booleanType",
- "validation": {
- "required": true
}, - "default": {
- "value": "true"
}, - "label": "Missed calls",
- "description": "If enabled, missed calls are indicated on the device. "
}, - {
- "id": "syslogServer",
- "type": "stringType",
- "validation": {
- "required": false,
- "lbound": 0,
- "ubound": 15
}, - "default": { },
- "label": "Syslog server ",
- "description": "IP address of the syslog server. "
}
]
}Get device capabilities
Get the capabilities of the provided SIP phone model.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| model required | string The SIP phone model |
query Parameters
| languageId | string The language to get labels in. Stated as a ISO 639-1 language code (e.g. 'sv' for Swedish) optionally combined with an ISO-3166 Country code (e.g. 'en_US' for US English). If not provided, the locale of the calling context is used. |
Responses
Response samples
- 200
- 400
Specification of a Poly VVX 350 SIP phone
{- "model": "polyVVX350",
- "mainline": {
- "category": "main_line",
- "index": 1,
- "options": [
- {
- "type": "line",
- "parameter": "user"
}
]
}, - "keysets": [
- {
- "category": "main_line",
- "lbound": 1,
- "ubound": 1,
- "labels": true,
- "options": [
- {
- "type": "line",
- "label": "Line",
- "parameter": "user"
}
]
}, - {
- "category": "line_key",
- "lbound": 2,
- "ubound": 34,
- "pagesize": 6,
- "labels": true,
- "options": [
- {
- "type": "extension",
- "label": "Extension",
- "parameter": "user"
}, - {
- "type": "phonenumber",
- "label": "Phone number",
- "parameter": "user_or_phonenumber"
}, - {
- "type": "take_call",
- "label": "Move here"
}
]
}
]
}Get supported expansion modules
Fetches the managed expansion modules of SIP devices of the provided type. Note that only the type of module is returned here.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| type required | string The model or type of the device |
Responses
Response samples
- 200
- 400
{- "modules": [
- {
- "type": "M685i"
}, - {
- "type": "M680i"
}
]
}Get firmware URLs
Get the available firmware URLs for the stated domain and device model or type.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| model required | string The model or type of the device |
Responses
Response samples
- 200
- 400
{- "firmwareURLs": [
]
}Get supported devices
Fetches the managed SIP phone models of the provided type (dect phones not supported).
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| type required | string Enum: "snom" "mitel" "miteldect" "polyvvx" "yealink" The type of the device |
Responses
Response samples
- 200
- 400
{- "models": [
- {
- "id": "polyVVX250",
- "name": "Poly VVX 250"
}, - {
- "id": "polyVVX350",
- "name": "Poly VVX 350"
}, - {
- "id": "polyVVX450",
- "name": "Poly VVX 450"
}
]
}Get provisioning URL
Get the provisioning URL for the stated domain and device model or type.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| model required | string The model or type of the device |
Responses
Response samples
- 200
- 400
{- "type": "snom",
}Get tone schemes
Get the available tone schemes for the stated domain and device model or type.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| model required | string The model or type of the device |
query Parameters
| languageId | string The language to get tone scheme labels in. Stated as a ISO 639-1 language code (e.g. 'sv' for Swedish) optionally combined with an ISO-3166-2 Country code (e.g. 'en_US' for US English). If not provided, the locale of the calling context is used. |
Responses
Response samples
- 200
- 400
Example of tone schemes for Yealink phones
{- "type": "yealink",
- "toneSchemes": [
- {
- "id": "United States",
- "name": "United States",
- "default": false
}, - {
- "id": "Portugal",
- "name": "Portugal",
- "default": true
}, - {
- "id": "Russia",
- "name": "Russia",
- "default": false
}, - {
- "id": "Greece",
- "name": "Greece",
- "default": false
}
]
}Get parameter values
Get allowed values for a key option parameter type in the stated domain. If a mainlineUser is provided, the result is filtered accordingly.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| type required | string The option parameter type for which to get valid values. Use the Get capabilities method to get available option parameter types for a device model. |
query Parameters
| languageId | string The language to get labels in. Stated as a ISO 639-1 language code (e.g. 'sv' for Swedish) optionally combined with an ISO-3166-2 Country code (e.g. 'en_US' for US English). If not provided, the locale of the calling context is used. |
| mainlineUser | string The userId of the seated or assigned user. The available values may vary depending on this. |
Responses
Response samples
- 200
- 400
Allowed Group Inbox function numbers in the organization
{- "parameterType": "group_inbox",
- "values": [
- {
- "name": "Group Inbox, team A",
- "value": "+4681234522"
}, - {
- "name": "Group Inbox, team B",
- "value": "+4681234523"
}
]
}The SIP Phone Profile API is used to create, modify and delete SIP phone profiles for users or organizations. The API is authenticated using API tickets for Device config.
SIP phone profiles are used to define which programmable keys that should be used on free seating phones for a user or all users in an organization. Only Mitel phones in free seating mode are supported.
Use the SIP Phone Profile API to:
- List all profiles defined for users in an organization
- Get the default profile of an organization
- Create or update the default profile of an organization
- Delete the default profile of an organization
- Get the profile defined for a user
- Create or update the profile defined for a user
- Delete the profile defined for a user
Get default profile
Fetches the default SIP phone profile of an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
Responses
Response samples
- 200
{- "orgId": 2,
- "profileName": "Default profile",
- "filterOptions": true,
- "disableContactImage": false,
- "disableMissedCallsIndication": false,
- "toneScheme": "Europe",
- "fixedKeys": [ ],
- "floatingKeys": [
- {
- "keysetType": "topKeys",
- "ordering": "top_down",
- "keys": [
- {
- "position": 1,
- "action": "logoff"
}
]
}, - {
- "keysetType": "bottomKeys",
- "ordering": "bottom_up",
- "keys": [
- {
- "position": 1,
- "action": "menu"
}
]
}
]
}Create/update default profile
Creates or updates the default SIP phone profile of an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
Request Body schema: application/jsonrequired
| profileName | string The name of the SIP phone profile. |
| filterOptions | boolean If true, a unique key option will only be applied once on any given phone instance. Fixed keys are applied before floating keys, and keyset priorities are expansion modules first, followed by top soft keys, bottom soft keys, function keys and speed dial (press-and-hold) keys. |
| disableContactImage | boolean Default: false Whether the phone should retrieve contact avatar images from the server, or not. If false, the contact images would be downloaded to the phone and would be cached for 120 hours. If true, the phones do not download contact images. |
| disableMissedCallsIndication | boolean Default: false If true, the phone will not increase the missed calls counter for the main line (line 1). Once the user presses the call log key (which will clear any current missed calls indication), the phone will no longer show missed calls indication. |
| toneScheme | string Enum: "Australia" "Brazil" "Europe" "France" "UK" "Germany" "Italy" "Italy2" "Malaysia" "Mexico" "Russia" "Slovakia" "US" The tone scheme the phone should use. |
Array of objects (PhoneProfileKeysetDTO) A list of keysets with fixed-position keys. | |
Array of objects (PhoneProfileKeysetDTO) A list of keysets with floating keys. Floating keysets are collapsed when saved (keys with positions 1, 3 and 5 will become 1, 2, and 3). |
Responses
Request samples
- Payload
{- "orgId": 2,
- "profileName": "Default profile",
- "filterOptions": true,
- "disableContactImage": false,
- "disableMissedCallsIndication": false,
- "toneScheme": "Europe",
- "fixedKeys": [ ],
- "floatingKeys": [
- {
- "keysetType": "topKeys",
- "ordering": "top_down",
- "keys": [
- {
- "position": 1,
- "action": "logoff"
}
]
}, - {
- "keysetType": "bottomKeys",
- "ordering": "bottom_up",
- "keys": [
- {
- "position": 1,
- "action": "menu"
}
]
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get profile
Fetches the SIP phone profile of a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| userid required | string The ID of the user. |
Responses
Response samples
- 200
{- "orgId": 2,
- "userId": "john",
- "profileName": "John's profile",
- "filterOptions": true,
- "disableContactImage": true,
- "disableMissedCallsIndication": true,
- "toneScheme": "Europe",
- "fixedKeys": [
- {
- "keysetType": "topKeys",
- "keys": [
- {
- "position": 1,
- "action": "directory_search"
}, - {
- "position": 2,
- "action": "phone_number",
- "attributes": [
- {
- "attribute": "parameter",
- "value": "123023"
}, - {
- "attribute": "label",
- "value": "Jane"
}
]
}
]
}
], - "floatingKeys": [ ]
}Create/update profile
Creates or updates the SIP phone profile for a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| userid required | string The ID of the user. |
Request Body schema: application/jsonrequired
| profileName | string The name of the SIP phone profile. |
| filterOptions | boolean If true, a unique key option will only be applied once on any given phone instance. Fixed keys are applied before floating keys, and keyset priorities are expansion modules first, followed by top soft keys, bottom soft keys, function keys and speed dial (press-and-hold) keys. |
| disableContactImage | boolean Default: false Whether the phone should retrieve contact avatar images from the server, or not. If false, the contact images would be downloaded to the phone and would be cached for 120 hours. If true, the phones do not download contact images. |
| disableMissedCallsIndication | boolean Default: false If true, the phone will not increase the missed calls counter for the main line (line 1). Once the user presses the call log key (which will clear any current missed calls indication), the phone will no longer show missed calls indication. |
| toneScheme | string Enum: "Australia" "Brazil" "Europe" "France" "UK" "Germany" "Italy" "Italy2" "Malaysia" "Mexico" "Russia" "Slovakia" "US" The tone scheme the phone should use. |
Array of objects (PhoneProfileKeysetDTO) A list of keysets with fixed-position keys. | |
Array of objects (PhoneProfileKeysetDTO) A list of keysets with floating keys. Floating keysets are collapsed when saved (keys with positions 1, 3 and 5 will become 1, 2, and 3). |
Responses
Request samples
- Payload
{- "orgId": 2,
- "userId": "john",
- "profileName": "John's profile",
- "filterOptions": true,
- "disableContactImage": true,
- "disableMissedCallsIndication": true,
- "toneScheme": "Europe",
- "fixedKeys": [
- {
- "keysetType": "topKeys",
- "keys": [
- {
- "position": 1,
- "action": "directory_search"
}, - {
- "position": 2,
- "action": "phone_number",
- "attributes": [
- {
- "attribute": "parameter",
- "value": "123023"
}, - {
- "attribute": "label",
- "value": "Jane"
}
]
}
]
}
], - "floatingKeys": [ ]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List profiles
Fetches a list with overview information of all SIP phone profiles defined for users in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
Responses
Response samples
- 200
{- "orgId": 2,
- "profiles": [
- {
- "userId": "john",
- "profileName": "John's profile"
}, - {
- "userId": "jane",
- "profileName": "Jane's profile"
}
]
}The Mobile Subscriber API is used to manage mobile subscribers.
Use the Mobile Subscriber API to:
- List mobile subscribers
- Get mobile subscriber
- Update mobile subscriber
- Add mobile subscriber
- Delete mobile subscriber
Update mobile subscriber
Use this metthod to modify a mobile subscriber.
Authorizations:
path Parameters
| domain required | string The domain of the Mobile Subscriber |
| mobNumber required | string The mobile number of the Mobile Subscriber |
Request Body schema:
| enablePbx required | boolean Temporarily disable routing to PBX for a MEX user. Defaults to true. |
| fullCallerId required | boolean true if the full number of the caller should always be displayed when call is received on the mobile, false otherwise. |
| number required | string The number of the mobile subscriber. Manadatory for POST. |
| numberPresentation required | string Enum: "FIXED" "MOBILE" Used to select whether the fixed number or mobile number should be used as calling number |
| parallelRingingFixed required | boolean If calls to fixed number should ring in parallel to the mobile |
| parallelRingingMobile required | boolean If calls to mobile, routed to the PBX, should ring in parallel to the mobile. |
| routeToPbx required | boolean Controls whether a call to the mobile number of a MEX user should be routed to the PBX rather than to the mobile phone. |
| shortNumberPresentation required | boolean true if short number should be used as calling number for calls within the organization, otherwise false. When false, the setting for numberPresentation applies to all calls. |
| subscriptionType required | string Enum: "MOBILE_VPN" "MEX" The type of the mobile subscriber. Mandatory for POST |
| orgId | integer <int32> |
| lastName | string The last name of the mobile subscriber. If none is stated, this element is omitted. |
| firstName | string The first name of the mobile subscriber. If none is stated, this element is omitted. |
| shortNumber | string The short number of the mobile subscriber. If the mobile subscriber does not have a short number configured, this element is omitted. |
| fixedNumber | string The diversion numberThe fixed (landline) number of the mobile subscriber. If the mobile subscriber does not have a fixed number configured, this element is omitted. |
| barGroupName | Array of strings Barring groups this mobile subscriber is a member of. If the subscriber is not member of any barring groups, this element is omitted |
| userGroupName | Array of strings User groups this mobile subscriber is a member of. If the subscriber is not member of any user groups, this element is omitted |
Responses
Request samples
- Payload
{- "orgId": 0,
- "lastName": "Smith",
- "firstName": "Alice",
- "number": "+44344343",
- "shortNumber": "4343",
- "subscriptionType": "MOBILE_VPN",
- "fixedNumber": "+14423455",
- "routeToPbx": false,
- "enablePbx": true,
- "parallelRingingMobile": true,
- "parallelRingingFixed": true,
- "barGroupName": [
- "string"
], - "shortNumberPresentation": true,
- "numberPresentation": "FIXED",
- "fullCallerId": false,
- "userGroupName": [
- "string"
]
}Response samples
- 404
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create mobile subscriber
Use this method to add a new mobile subscriber.
Authorizations:
path Parameters
| domain required | string The domain of the Mobile Subscriber |
| mobNumber required | string The mobile number of the Mobile Subscriber |
Request Body schema:
| enablePbx required | boolean Temporarily disable routing to PBX for a MEX user. Defaults to true. |
| fullCallerId required | boolean true if the full number of the caller should always be displayed when call is received on the mobile, false otherwise. |
| number required | string The number of the mobile subscriber. Manadatory for POST. |
| numberPresentation required | string Enum: "FIXED" "MOBILE" Used to select whether the fixed number or mobile number should be used as calling number |
| parallelRingingFixed required | boolean If calls to fixed number should ring in parallel to the mobile |
| parallelRingingMobile required | boolean If calls to mobile, routed to the PBX, should ring in parallel to the mobile. |
| routeToPbx required | boolean Controls whether a call to the mobile number of a MEX user should be routed to the PBX rather than to the mobile phone. |
| shortNumberPresentation required | boolean true if short number should be used as calling number for calls within the organization, otherwise false. When false, the setting for numberPresentation applies to all calls. |
| subscriptionType required | string Enum: "MOBILE_VPN" "MEX" The type of the mobile subscriber. Mandatory for POST |
| orgId | integer <int32> |
| lastName | string The last name of the mobile subscriber. If none is stated, this element is omitted. |
| firstName | string The first name of the mobile subscriber. If none is stated, this element is omitted. |
| shortNumber | string The short number of the mobile subscriber. If the mobile subscriber does not have a short number configured, this element is omitted. |
| fixedNumber | string The diversion numberThe fixed (landline) number of the mobile subscriber. If the mobile subscriber does not have a fixed number configured, this element is omitted. |
| barGroupName | Array of strings Barring groups this mobile subscriber is a member of. If the subscriber is not member of any barring groups, this element is omitted |
| userGroupName | Array of strings User groups this mobile subscriber is a member of. If the subscriber is not member of any user groups, this element is omitted |
Responses
Request samples
- Payload
{- "orgId": 0,
- "lastName": "Smith",
- "firstName": "Alice",
- "number": "+44344343",
- "shortNumber": "4343",
- "subscriptionType": "MOBILE_VPN",
- "fixedNumber": "+14423455",
- "routeToPbx": false,
- "enablePbx": true,
- "parallelRingingMobile": true,
- "parallelRingingFixed": true,
- "barGroupName": [
- "string"
], - "shortNumberPresentation": true,
- "numberPresentation": "FIXED",
- "fullCallerId": false,
- "userGroupName": [
- "string"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get mobile subscriber
Retrieve the details of a mobile subscriber.
Authorizations:
path Parameters
| domain required | string The domain of the Mobile Subscriber |
| number required | string The mobile number of the Mobile Subscriber |
Responses
Response samples
- 200
{- "orgId": 0,
- "lastName": "Smith",
- "firstName": "Alice",
- "number": "+44344343",
- "shortNumber": "4343",
- "subscriptionType": "MOBILE_VPN",
- "fixedNumber": "+14423455",
- "routeToPbx": false,
- "enablePbx": true,
- "parallelRingingMobile": true,
- "parallelRingingFixed": true,
- "barGroupName": [
- "string"
], - "shortNumberPresentation": true,
- "numberPresentation": "FIXED",
- "fullCallerId": false,
- "userGroupName": [
- "string"
]
}List mobile subscribers
Lists the overview information on mobile subscribers in the organization.
Authorizations:
path Parameters
| domain required | string The domain of the Mobile Subscribers |
Responses
Response samples
- 200
{- "firstName": "Smith",
- "lastName": "+449929334",
- "number": "Jon",
- "type": "MOBILE_VPN"
}The User Administration API is used to manage users.
Use the User Administration API to:
- Get user
- Update user
- Create user
- Delete user
- List users
- Get the count of users in an organization
- Download all users as a CSV list
- Send activation message
Get user
Use this API to retrieve details of a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Responses
Response samples
- 200
End User
{- "userId": "albo",
- "customId": "alicebob",
- "name": {
- "givenName": "Alice",
- "familyName": "Bob"
}, - "pinCode": "1234",
- "userLicenseType": "BUSINESS_LINE_PLUS_USER",
- "password": {
- "value": "aa975dc3fd1d1db78ce538e487813925",
- "md5": "true"
}, - "email": "alice.smith001@example.com",
- "costCenter": "12345qwerty",
- "language": "en",
- "timeZoneId": "UTC",
- "contactSearch": true,
- "authorizeSearch": false,
- "ipadSupport": true,
- "directoryContact": false,
- "exchangeId": "alice.bob@example.com",
- "eTrunkDestinationLine": "PBX_IDENTIFIER",
- "billingInfo": "",
- "billingId": "12344",
- "callerTagsOverride": "APPEND",
- "exchangeSync": false,
- "lyncPhone": false,
- "lyncPresence": false,
- "mobileVoip": true,
- "calledLineId": true,
- "attendant": true,
- "premiumAttendant": false,
- "supervisor": false,
- "premiumIntrusion": false,
- "callControlApi": false,
- "cloudCtiApi": false,
- "lineStateApi": false,
- "callRecording": false,
- "ucAnalyticsRole": "NONE",
- "cloudCrmConnector": false,
- "collaboration": true,
- "unifiedInbox": true,
- "genericCallRecording": false,
- "callRecordingType": "NONE",
- "storagePeriod": "_30_DAYS",
- "recordingPortalAccess": false,
- "recordingPortalAdmin": false,
- "personalCallRecording": false,
- "teamsApplication": false,
- "teamsTelephony": false,
- "teamsTelephonyGo": false,
- "webSoftphone": false,
- "crmConnect": false,
- "chat": false,
- "ignorePasswordExpiry": false,
- "ignoreTppPasswordExpiry": false,
- "phoneNumbers": [
- {
- "type": "PRIMARY",
- "numberType": "OFFICE_FIXED",
- "mobileVPN": false,
- "value": "+123460000",
- "aliases": [
- {
- "shortNumber": false,
- "value": "+123467000"
}
]
}, - {
- "type": "SECONDARY",
- "numberType": "OFFICE_MOBILE",
- "mobileVPN": false,
- "value": "+123467890"
}
], - "administrativeRoles": [
- "USER"
], - "userGroups": [
- "attendant_101"
], - "answerPlaces": [
- {
- "type": "SOFT",
- "privateTel": "+123460000"
}, - {
- "fullCallerId": true,
- "enablePbx": false,
- "active": true,
- "value": "iPhone",
- "type": "MOBILE",
- "profile": "profile2",
- "privateTel": "+123467890",
- "client": "NONE"
}, - {
- "type": "DESKTOP",
- "privateTel": "+123460000"
}
], - "dirFields": { },
- "callerTags": [
- "caller_telepo_org"
], - "saaSearchableUser": false,
- "federatedProfileName": "Example System"
}Update user
This API is used to update a user in an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user accessing the API |
query Parameters
| autoGeneratePassword | boolean Query parameter to auto generate a random password as per the configured settings. If set to true, the password element sent in the request payload will be ignored and random password will be generated for the user |
Request Body schema:
| administrativeRoles required | Array of strings Items Enum: "ADMIN" "USER" The administrative role of a user. Multiple roles are described by having multiple tags. |
| contactSearch required | boolean Whether the user should appear in search results. |
| email required | string The user's email address. A string, max 64 characters long. |
| language required | string The user's language (locale) stated as two lowercase letters (ISO 639-1), optionally appended with a country code (ISO 3166-1 alpha-2). |
required | object (Name) The name of the user |
required | object (Password) The user password |
| userId required | string The user id or the username without domain. Must match the regexp ^[a-z][a-z_0-9.-]*$ and must not start with a reserved prefix. |
| customId | string The users custom Id, which could be used for login. Can for example be either email (valid address) or a number. It cannot start with device or fax. Must be unique across organizations when specified. Minimum length allowed is five. |
| pinCode | string The PIN code |
| userLicenseType | string Enum: "SIP_REGISTRAR" "BUSINESS_LINE_USER" "BUSINESS_LINE_PLUS_USER" The type of the user license |
object (ThirdPartyPhone) Third party phone support. | |
| resetPassword | boolean Set to 'true' to generate a random user password. |
object (DepartmentWrapper) | |
| costCenter | string The cost center. A string, max 64 characters long. |
| deviceLocationName | string The primary location of the user. |
| countryCode | string The user's country code, stated as two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value. |
| timeZoneId | string The user's time zone. If this field is not set, the default time zone for the system will be used. When specified, it should match a valid timezone in IANA timezone database (tzdata). |
| authorizeSearch | boolean Whether the user requires authorization to be searched for. |
| adminProfile | string The administrative profile of an administrator. If not set when adding an administrator, the default profile is set. The different profile configurations are administrated from the web interface. |
| adminType | string Enum: "SINGLE_HOME_ORG" "LINKED_ORGS" "MULTIPLE_ORGS" Specifies which linked organizations an administrator can manage. |
| groupAdminProfile | string The administrative profile of a group administrator. If a user should be an administrator they can be either administrator or group administrator, that is if a groupAdminProfile is set, the user must not have the role set to admin. A group administrator has access to limited set of features, limited to the groups specified by the profile and function numbers with the same groupAdminProfile. The profiles are administrated from the User administration / Group administrator profiles page in the web interface. |
| userProfile | string The user profile |
| ipadSupport | boolean If support for iPad should be active for a user. |
| forkToAllMobiles | boolean If all mobile phones should be active for a user. |
| directoryContact | boolean If this entry describes a directory contact. |
| exchangeId | string The Microsoft Exchange ID. This should be a valid exchange ID address. |
| lyncPresenceId | string The ID of the user to use for Skype for Business presence integration. This should be a valid Skype for Business Id. |
| lyncId | string The id or phone number for the user on the external telephony system. This should be SIP URI or a telephony number. |
| eTrunkDestinationLine | string Enum: "PBX_IDENTIFIER" "PRIMARY_LINE" "SECONDARY_LINE" "CALLED_LINE" The id that should be used when inbound calls to the user are forwarded to the external telephony system. Default is PBX_IDENTIFIER. |
| field1 | string Deprecated Use dirField property instead. |
| field2 | string Deprecated Use dirField property instead. |
| field3 | string Deprecated Use dirField property instead. |
| field4 | string Deprecated Use dirField property instead. |
| field5 | string Deprecated Use dirField property instead. |
| field6 | string Deprecated Use dirField property instead. |
| billingInfo | string User specific billing related data. Free text field, maximum length is 1024 characters. XML text is possible. |
| billingId | string User specific billing id for integration into external billing system. |
| callerTagsOverride | string Enum: "EMPTY" "APPEND" "REPLACE" "KEEP_NUMBER_RANGE_TAGS" Specify how the call tags interact with the number range based source tags |
| exchangeSync | boolean Enable Exchange calendar synchronization. |
| lyncPhone | boolean Indicates whether integration with an external telephony system, like Microsoft Skype for Business, is enabled. |
| lyncPresence | boolean Enable Microsoft Skype for Business presence. |
| mobileVoip | boolean Indicates whether mobile VoIP is enabled |
| calledLineId | boolean Indicates whether called line identification is enabled |
| attendant | boolean Indicates whether Attendant functionality is enabled |
| premiumAttendant | boolean Indicates whether Premium Attendant functionality is enabled |
| supervisor | boolean Indicates whether ACD Supervisor functionality is enabled |
| premiumIntrusion | boolean Indicates whether premium intrusion features, i.e barge-in, call whisper, silent monitor are enabled |
| callControlApi | boolean Indicates whether Call Control API functionality is enabled |
| cloudCtiApi | boolean Indicates whether Cloud CTI API functionality is enabled |
| lineStateApi | boolean Indicates whether line state API functionality is enabled |
| callRecording | boolean Indicates whether UC Analytics Call Recording is enabled |
| callRecordingAgentDesktop | boolean Indicates whether UC Analytics Call Recording Agent Desktop is enabled |
| ucAnalyticsRole | string Enum: "NONE" "CONSOLE_USER" "SUPER_USER" The UC Analytics role |
| cloudCrmConnector | boolean Indicates whether Cloud CRM Connector is enabled |
| collaboration | boolean Indicates whether MiTeam collaboration is enabled |
| unifiedInbox | boolean Indicates whether the user can use Unified Inbox feature. |
| genericCallRecording | boolean Indicates whether Generic Call Recording is enabled, must not conflict with callRecordingType field |
| callRecordingType | string Enum: "NONE" "GENERIC" "PLUS" "PREMIUM" "NONE" "GENERIC" "PLUS" "PREMIUM" Indicates the type of call recording, must not conflict with genericCallRecording field |
| storagePeriod | string Enum: "_30_DAYS" "_90_DAYS" "_1_YEAR" "_7_YEARS" "_10_YEARS" "_30_DAYS" "_90_DAYS" "_1_YEAR" "_7_YEARS" "_10_YEARS" The period to store call recordings. Mandatory if callRecordingType is PLUS or PREMIUM |
| recordingPortalAccess | boolean Does the user have access to the Premium call recording portal |
| recordingPortalAdmin | boolean Does the user have super admin access to the Premium call recording portal |
| personalCallRecording | boolean Indicates whether Personal call recording is enabled |
| twoFactorAuthMobileNumber | string Mobile number to receive two-factor authentication token through SMS |
| teamsApplication | boolean Indicates whether the user is enabled for use of Teams application |
| teamsTelephony | boolean Indicates whether the user has Teams with telephony integration |
| teamsTelephonyGo | boolean Indicates whether the user has Teams with telephony integration and support for phone application |
| webSoftphone | boolean Indicates whether the user is enabled for use of web softphone |
| crmConnect | boolean Indicates whether the user is enabled for use of CRM Connect |
| chat | boolean Indicates whether the user has chat |
| ignorePasswordExpiry | boolean By setting this field, the password expiration will be ignored, and the user can continue logging in even after it expires |
| ignoreTppPasswordExpiry | boolean By setting this field, the 3rd party SIP phone password expiration will be ignored, and the user can continue logging in even after it expires |
Array of objects (PhoneDTO) A list of phone numbers the user can be reached at. Required if role has USER. | |
| adminDomains | Array of strings Specifies which linked organizations an administrator can manage. |
| userGroups | Array of strings unique The user group or barring group. You can assign many groups to a user. |
Array of objects (AnswerPlaceDTO) A list of answer places for the user. | |
object (dirFields) This field contains extra description for the user directory fields 1-20. | |
| callerTags | Array of strings unique A list of Caller Tags. |
| disableDate | string Disable a user. If this has a value the user is disabled. If empty, or non existing, the user is active. Time in ISO 8601 format with milliseconds. yyyy-mm-ddTHH:MM:SS.SSS+HH:MM |
| saaSearchableUser | boolean Indicates whether the user can be searched using Speech Auto Attendant |
Array of objects (FederatedIdentity) If stated, overrides email address as federated identity for Service Mediation Gateway login | |
| federatedProfileName | string Description of this user in case several users match the Service Mediation Gateway login |
Responses
Request samples
- Payload
End User
{- "userId": "albo",
- "customId": "alicebob",
- "name": {
- "givenName": "Alice",
- "familyName": "Bob"
}, - "pinCode": "1234",
- "userLicenseType": "BUSINESS_LINE_PLUS_USER",
- "password": {
- "value": "aa975dc3fd1d1db78ce538e487813925",
- "md5": "true"
}, - "email": "alice.smith001@example.com",
- "costCenter": "12345qwerty",
- "language": "en",
- "timeZoneId": "UTC",
- "contactSearch": true,
- "authorizeSearch": false,
- "ipadSupport": true,
- "directoryContact": false,
- "exchangeId": "alice.bob@example.com",
- "eTrunkDestinationLine": "PBX_IDENTIFIER",
- "billingInfo": "",
- "billingId": "12344",
- "callerTagsOverride": "APPEND",
- "exchangeSync": false,
- "lyncPhone": false,
- "lyncPresence": false,
- "mobileVoip": true,
- "calledLineId": true,
- "attendant": true,
- "premiumAttendant": false,
- "supervisor": false,
- "premiumIntrusion": false,
- "callControlApi": false,
- "cloudCtiApi": false,
- "lineStateApi": false,
- "callRecording": false,
- "ucAnalyticsRole": "NONE",
- "cloudCrmConnector": false,
- "collaboration": true,
- "unifiedInbox": true,
- "genericCallRecording": false,
- "callRecordingType": "NONE",
- "storagePeriod": "_30_DAYS",
- "recordingPortalAccess": false,
- "recordingPortalAdmin": false,
- "personalCallRecording": false,
- "teamsApplication": false,
- "teamsTelephony": false,
- "teamsTelephonyGo": false,
- "webSoftphone": false,
- "crmConnect": false,
- "chat": false,
- "ignorePasswordExpiry": false,
- "ignoreTppPasswordExpiry": false,
- "phoneNumbers": [
- {
- "type": "PRIMARY",
- "numberType": "OFFICE_FIXED",
- "mobileVPN": false,
- "value": "+123460000",
- "aliases": [
- {
- "shortNumber": false,
- "value": "+123467000"
}
]
}, - {
- "type": "SECONDARY",
- "numberType": "OFFICE_MOBILE",
- "mobileVPN": false,
- "value": "+123467890"
}
], - "administrativeRoles": [
- "USER"
], - "userGroups": [
- "attendant_101"
], - "answerPlaces": [
- {
- "type": "SOFT",
- "privateTel": "+123460000"
}, - {
- "fullCallerId": true,
- "enablePbx": false,
- "active": true,
- "value": "iPhone",
- "type": "MOBILE",
- "profile": "profile2",
- "privateTel": "+123467890",
- "client": "NONE"
}, - {
- "type": "DESKTOP",
- "privateTel": "+123460000"
}
], - "dirFields": { },
- "callerTags": [
- "caller_telepo_org"
], - "saaSearchableUser": false,
- "federatedProfileName": "Example System"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create user
This API is used to create a new user in the organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the new user |
query Parameters
| autoGeneratePassword | boolean Query parameter to auto generate a random password as per the configured settings. If set to true, the password element sent in the request payload will be ignored and random password will be generated for the user |
Request Body schema:
| administrativeRoles required | Array of strings Items Enum: "ADMIN" "USER" The administrative role of a user. Multiple roles are described by having multiple tags. |
| contactSearch required | boolean Whether the user should appear in search results. |
| email required | string The user's email address. A string, max 64 characters long. |
| language required | string The user's language (locale) stated as two lowercase letters (ISO 639-1), optionally appended with a country code (ISO 3166-1 alpha-2). |
required | object (Name) The name of the user |
required | object (Password) The user password |
| userId required | string The user id or the username without domain. Must match the regexp ^[a-z][a-z_0-9.-]*$ and must not start with a reserved prefix. |
| customId | string The users custom Id, which could be used for login. Can for example be either email (valid address) or a number. It cannot start with device or fax. Must be unique across organizations when specified. Minimum length allowed is five. |
| pinCode | string The PIN code |
| userLicenseType | string Enum: "SIP_REGISTRAR" "BUSINESS_LINE_USER" "BUSINESS_LINE_PLUS_USER" The type of the user license |
object (ThirdPartyPhone) Third party phone support. | |
| resetPassword | boolean Set to 'true' to generate a random user password. |
object (DepartmentWrapper) | |
| costCenter | string The cost center. A string, max 64 characters long. |
| deviceLocationName | string The primary location of the user. |
| countryCode | string The user's country code, stated as two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value. |
| timeZoneId | string The user's time zone. If this field is not set, the default time zone for the system will be used. When specified, it should match a valid timezone in IANA timezone database (tzdata). |
| authorizeSearch | boolean Whether the user requires authorization to be searched for. |
| adminProfile | string The administrative profile of an administrator. If not set when adding an administrator, the default profile is set. The different profile configurations are administrated from the web interface. |
| adminType | string Enum: "SINGLE_HOME_ORG" "LINKED_ORGS" "MULTIPLE_ORGS" Specifies which linked organizations an administrator can manage. |
| groupAdminProfile | string The administrative profile of a group administrator. If a user should be an administrator they can be either administrator or group administrator, that is if a groupAdminProfile is set, the user must not have the role set to admin. A group administrator has access to limited set of features, limited to the groups specified by the profile and function numbers with the same groupAdminProfile. The profiles are administrated from the User administration / Group administrator profiles page in the web interface. |
| userProfile | string The user profile |
| ipadSupport | boolean If support for iPad should be active for a user. |
| forkToAllMobiles | boolean If all mobile phones should be active for a user. |
| directoryContact | boolean If this entry describes a directory contact. |
| exchangeId | string The Microsoft Exchange ID. This should be a valid exchange ID address. |
| lyncPresenceId | string The ID of the user to use for Skype for Business presence integration. This should be a valid Skype for Business Id. |
| lyncId | string The id or phone number for the user on the external telephony system. This should be SIP URI or a telephony number. |
| eTrunkDestinationLine | string Enum: "PBX_IDENTIFIER" "PRIMARY_LINE" "SECONDARY_LINE" "CALLED_LINE" The id that should be used when inbound calls to the user are forwarded to the external telephony system. Default is PBX_IDENTIFIER. |
| field1 | string Deprecated Use dirField property instead. |
| field2 | string Deprecated Use dirField property instead. |
| field3 | string Deprecated Use dirField property instead. |
| field4 | string Deprecated Use dirField property instead. |
| field5 | string Deprecated Use dirField property instead. |
| field6 | string Deprecated Use dirField property instead. |
| billingInfo | string User specific billing related data. Free text field, maximum length is 1024 characters. XML text is possible. |
| billingId | string User specific billing id for integration into external billing system. |
| callerTagsOverride | string Enum: "EMPTY" "APPEND" "REPLACE" "KEEP_NUMBER_RANGE_TAGS" Specify how the call tags interact with the number range based source tags |
| exchangeSync | boolean Enable Exchange calendar synchronization. |
| lyncPhone | boolean Indicates whether integration with an external telephony system, like Microsoft Skype for Business, is enabled. |
| lyncPresence | boolean Enable Microsoft Skype for Business presence. |
| mobileVoip | boolean Indicates whether mobile VoIP is enabled |
| calledLineId | boolean Indicates whether called line identification is enabled |
| attendant | boolean Indicates whether Attendant functionality is enabled |
| premiumAttendant | boolean Indicates whether Premium Attendant functionality is enabled |
| supervisor | boolean Indicates whether ACD Supervisor functionality is enabled |
| premiumIntrusion | boolean Indicates whether premium intrusion features, i.e barge-in, call whisper, silent monitor are enabled |
| callControlApi | boolean Indicates whether Call Control API functionality is enabled |
| cloudCtiApi | boolean Indicates whether Cloud CTI API functionality is enabled |
| lineStateApi | boolean Indicates whether line state API functionality is enabled |
| callRecording | boolean Indicates whether UC Analytics Call Recording is enabled |
| callRecordingAgentDesktop | boolean Indicates whether UC Analytics Call Recording Agent Desktop is enabled |
| ucAnalyticsRole | string Enum: "NONE" "CONSOLE_USER" "SUPER_USER" The UC Analytics role |
| cloudCrmConnector | boolean Indicates whether Cloud CRM Connector is enabled |
| collaboration | boolean Indicates whether MiTeam collaboration is enabled |
| unifiedInbox | boolean Indicates whether the user can use Unified Inbox feature. |
| genericCallRecording | boolean Indicates whether Generic Call Recording is enabled, must not conflict with callRecordingType field |
| callRecordingType | string Enum: "NONE" "GENERIC" "PLUS" "PREMIUM" "NONE" "GENERIC" "PLUS" "PREMIUM" Indicates the type of call recording, must not conflict with genericCallRecording field |
| storagePeriod | string Enum: "_30_DAYS" "_90_DAYS" "_1_YEAR" "_7_YEARS" "_10_YEARS" "_30_DAYS" "_90_DAYS" "_1_YEAR" "_7_YEARS" "_10_YEARS" The period to store call recordings. Mandatory if callRecordingType is PLUS or PREMIUM |
| recordingPortalAccess | boolean Does the user have access to the Premium call recording portal |
| recordingPortalAdmin | boolean Does the user have super admin access to the Premium call recording portal |
| personalCallRecording | boolean Indicates whether Personal call recording is enabled |
| twoFactorAuthMobileNumber | string Mobile number to receive two-factor authentication token through SMS |
| teamsApplication | boolean Indicates whether the user is enabled for use of Teams application |
| teamsTelephony | boolean Indicates whether the user has Teams with telephony integration |
| teamsTelephonyGo | boolean Indicates whether the user has Teams with telephony integration and support for phone application |
| webSoftphone | boolean Indicates whether the user is enabled for use of web softphone |
| crmConnect | boolean Indicates whether the user is enabled for use of CRM Connect |
| chat | boolean Indicates whether the user has chat |
| ignorePasswordExpiry | boolean By setting this field, the password expiration will be ignored, and the user can continue logging in even after it expires |
| ignoreTppPasswordExpiry | boolean By setting this field, the 3rd party SIP phone password expiration will be ignored, and the user can continue logging in even after it expires |
Array of objects (PhoneDTO) A list of phone numbers the user can be reached at. Required if role has USER. | |
| adminDomains | Array of strings Specifies which linked organizations an administrator can manage. |
| userGroups | Array of strings unique The user group or barring group. You can assign many groups to a user. |
Array of objects (AnswerPlaceDTO) A list of answer places for the user. | |
object (dirFields) This field contains extra description for the user directory fields 1-20. | |
| callerTags | Array of strings unique A list of Caller Tags. |
| disableDate | string Disable a user. If this has a value the user is disabled. If empty, or non existing, the user is active. Time in ISO 8601 format with milliseconds. yyyy-mm-ddTHH:MM:SS.SSS+HH:MM |
| saaSearchableUser | boolean Indicates whether the user can be searched using Speech Auto Attendant |
Array of objects (FederatedIdentity) If stated, overrides email address as federated identity for Service Mediation Gateway login | |
| federatedProfileName | string Description of this user in case several users match the Service Mediation Gateway login |
Responses
Request samples
- Payload
End User
{- "userId": "albo",
- "customId": "alicebob",
- "name": {
- "givenName": "Alice",
- "familyName": "Bob"
}, - "pinCode": "1234",
- "userLicenseType": "BUSINESS_LINE_PLUS_USER",
- "password": {
- "value": "aa975dc3fd1d1db78ce538e487813925",
- "md5": "true"
}, - "email": "alice.smith001@example.com",
- "costCenter": "12345qwerty",
- "language": "en",
- "timeZoneId": "UTC",
- "contactSearch": true,
- "authorizeSearch": false,
- "ipadSupport": true,
- "directoryContact": false,
- "exchangeId": "alice.bob@example.com",
- "eTrunkDestinationLine": "PBX_IDENTIFIER",
- "billingInfo": "",
- "billingId": "12344",
- "callerTagsOverride": "APPEND",
- "exchangeSync": false,
- "lyncPhone": false,
- "lyncPresence": false,
- "mobileVoip": true,
- "calledLineId": true,
- "attendant": true,
- "premiumAttendant": false,
- "supervisor": false,
- "premiumIntrusion": false,
- "callControlApi": false,
- "cloudCtiApi": false,
- "lineStateApi": false,
- "callRecording": false,
- "ucAnalyticsRole": "NONE",
- "cloudCrmConnector": false,
- "collaboration": true,
- "unifiedInbox": true,
- "genericCallRecording": false,
- "callRecordingType": "NONE",
- "storagePeriod": "_30_DAYS",
- "recordingPortalAccess": false,
- "recordingPortalAdmin": false,
- "personalCallRecording": false,
- "teamsApplication": false,
- "teamsTelephony": false,
- "teamsTelephonyGo": false,
- "webSoftphone": false,
- "crmConnect": false,
- "chat": false,
- "ignorePasswordExpiry": false,
- "ignoreTppPasswordExpiry": false,
- "phoneNumbers": [
- {
- "type": "PRIMARY",
- "numberType": "OFFICE_FIXED",
- "mobileVPN": false,
- "value": "+123460000",
- "aliases": [
- {
- "shortNumber": false,
- "value": "+123467000"
}
]
}, - {
- "type": "SECONDARY",
- "numberType": "OFFICE_MOBILE",
- "mobileVPN": false,
- "value": "+123467890"
}
], - "administrativeRoles": [
- "USER"
], - "userGroups": [
- "attendant_101"
], - "answerPlaces": [
- {
- "type": "SOFT",
- "privateTel": "+123460000"
}, - {
- "fullCallerId": true,
- "enablePbx": false,
- "active": true,
- "value": "iPhone",
- "type": "MOBILE",
- "profile": "profile2",
- "privateTel": "+123467890",
- "client": "NONE"
}, - {
- "type": "DESKTOP",
- "privateTel": "+123460000"
}
], - "dirFields": { },
- "callerTags": [
- "caller_telepo_org"
], - "saaSearchableUser": false,
- "federatedProfileName": "Example System"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Download users as CSV
This API method is used to download all the users in an organization as a CSV (Comma Separated Values) file. If the query parameter 'data' has value 'full', then semicolon is used instead of comma as the separator.
Authorizations:
path Parameters
| domain required | string The organization domain |
query Parameters
| data | string Set to 'extended' to get extended data with additional fields, or 'full' to get all data as with bulk download from user admin page |
Responses
List users
This method for listing users in a domain. Searching for users matching a specific criterion can be done by appending a query parameter to the request.
Note: The primary number field in the response is currently not set.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| query | string Search filter that will limit the output to those users where query matches some parameters (name, userid, roles). If no query is specified the whole "?query={query}" part should be omitted |
Responses
Response samples
- 200
{- "user": [
- {
- "name": "Alice Smith",
- "userId": "alice.smith"
}, - {
- "name": "Bob Smith",
- "userId": "bob.smith"
}
]
}Send activation message
This API is used to send activation message to user(s) in organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| userId | Array of strings List of user ids |
| sendSms | boolean Whether welcome messages are sent as SMS |
| sendEmail | boolean Whether welcome messages are sent as email |
| sendForTablet | boolean Whether welcome messages are sent for Tablet app |
| sendForMobile | boolean Whether welcome messages are sent for Mobile app |
| sendForSoftphone | boolean Whether welcome messages are sent for Softphone app |
| sendForWeb | boolean Whether welcome messages are sent for Web |
| sendForWebSoftphone | boolean Whether welcome messages are sent for Web softphone |
| sendForCrm | boolean Whether welcome messages are sent for CRM |
Responses
Request samples
- Payload
{- "userId": [
- "user1"
], - "sendSms": false,
- "sendEmail": true,
- "sendForTablet": true,
- "sendForMobile": true,
- "sendForSoftphone": true,
- "sendForWeb": false,
- "sendForWebSoftphone": false,
- "sendForCrm": false
}Response samples
- 200
- 400
{- "activationResultDTOs": [
- {
- "havingFailureReasons": false,
- "success": false,
- "failure": false,
- "warning": false,
- "userId": "user1@example.com",
- "devices": [
- {
- "emailsent": false,
- "smsSent": false,
- "success": false,
- "failure": true,
- "warning": false,
- "deviceType": "Mobile",
- "isEmailsent": false,
- "isSmsSent": false,
- "isSuccess": false,
- "isFailure": true,
- "isWarning": false,
- "failureReasons": [
- "No mobile number configured for user."
]
}
], - "isFailure": false,
- "isSuccess": false,
- "isWarning": false,
- "isHavingFailureReasons": false
}
], - "handledUsers": 1,
- "failedUsers": 1,
- "succeededUsers": 0
}The Configuration API is used to fetch configuration strings.
Use the Configuration API to:
- List presence roles
List presence role strings
Retrieve the localized strings for presence roles.
Authorizations:
path Parameters
| domain required | string The domain of the user accessing the API |
| user required | string The username of the user accessing the API |
Responses
Response samples
- 200
Available roles, localized in English
{- "role": [
- {
- "id": "business",
- "name": "Business",
- "stateName": "Business"
}, - {
- "id": "private",
- "name": "Private",
- "stateName": "Private"
}, - {
- "id": "1400593658949",
- "name": "Support",
- "stateName": "Support"
}
]
}The User Device Information API is used to manage information about end user devices.
Use the User Device Information API to:
- Get a list with overview information on all the user's currently active devices
- Get a list with information about all user's devices
- Get detailed information about a specific device
- Get the name used for a specific device
- Set or update the name to use for a specific device
- Get the name of the icon used for a specific device
- Set or update the name of the icon to use for a specific device
- Revoke the installation of a specific device
Unregister device updates webhook
Unregister an existing webhook registered for the user.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| userId required | string The ID of the user |
| targetId required | string The unique id of the webhook that should be unregistered |
Responses
Get user device
Retrieve detailed information about a certain user device. The returned document contains a list of attributes providing detailed information about the user's device.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| deviceId required | string The device ID |
Responses
Response samples
- 200
[- {
- "name": "USER_AGENT",
- "value": "Telepo Softphone/Mac/5.x.x.xxxx"
}
]Get user device icon name
Retrieve display icon name for a certain user device. If no icon has been configured for the device, the default icon of the type of the device is returned.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| deviceId required | string The device ID |
query Parameters
| fallback | boolean If true, the default icon name will be returned if no name is configured |
Responses
Response samples
- 200
"DESKPHONE_TYPE_2"Update user device icon name
Set or Update the display icon name for a certain user device. The icon name must correspond to the type of the device.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| deviceId required | string The device ID |
query Parameters
| name required | string Enum: "DEFAULT" "TYPE_1" "TYPE_2" The display icon name of the device to be updated |
Responses
List all user devices
Retrieve a list with all the user's devices. The returned document contains a list with information on all the user's devices. If there are no devices, an empty document is returned.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
query Parameters
| type | string Enum: "MOBILE" "TABLET" "SOFTPHONE" "DESKPHONE" "PBX" "DECT" "THIRD_PARTY" "WEB_SOFTPHONE" "TEAMS" The type of devices to fetch. If not stated, all device types are retrieved. |
Responses
Response samples
- 200
[- {
- "deviceId": "kf45ffr3dd3dtj7r",
- "deviceType": "SOFTPHONE",
- "deviceName": "My work laptop",
- "deviceIcon": "DEFAULT",
- "deviceTypeName": "Application for Desktop",
- "deviceStatus": "INACTIVE",
- "revocable": true,
- "hasAttributes": true
}, - {
- "deviceId": "dhhjhdsb008jnnh",
- "deviceType": "MOBILE",
- "deviceName": "My black iPhone XS",
- "deviceIcon": "TYPE_2",
- "deviceTypeName": "Mobile Application",
- "deviceStatus": "ACTIVE",
- "revocable": true,
- "hasAttributes": true
}
]Get user device name
Retrieve display name of certain user device.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| deviceId required | string The device ID |
query Parameters
| fallback | boolean If true, the default name will be returned if no name is configured |
Responses
Response samples
- 200
"My work laptop"Update user device name
Set or Update the display name of a certain user device.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
| deviceId required | string The device ID |
query Parameters
| name required | string The display name of the device to be updated (max 32 characters) |
Responses
List active user devices
Retrieve a compact list with all the user's active devices. The returned document contains all the user's devices that are not known to be currently unreachable. If there are no active devices, an empty document is returned.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user ID |
Responses
Response samples
- 200
[- {
- "deviceId": "dhhjhdsb008jnnh",
- "deviceType": "MOBILE",
- "deviceName": "My black iPhone XS",
- "deviceIcon": "TYPE_2"
}
]Register device updates webhook
Register a webhook where notifications when there are any changes in the user's device set.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| userId required | string The ID of the user |
Request Body schema: application/json
| publicTarget required | boolean Indicates if the target node hosting the webhook is deployed on the same network segment as the service nodes or if callbacks needs to go through the edge http proxy |
| targetId required | string A unique id of the webhook. |
| targetUrl required | string The webhook url |
Responses
Callbacks
Request samples
- Payload
{- "targetId": "434356",
- "publicTarget": true
}Response samples
- 200
- 400
{- "expiresOn": 3600
}Callback payload samples
{- "userId": "alice@organization.org",
- "timeStamp": "2025-10-21 23:00:57.470",
- "changedField": "DEVICE_INFO"
}Subscribe for user devices updates
Subscribe for update events when there are any changes in the users device set. Subscription data is in application/app-config-data format.
Authorizations:
path Parameters
| domain required | string The domain of the organization the user belongs to |
| userId required | string The user id |
Responses
The User Line API is used to manage caller ID for a user.
Use User Line API to:
- Get available user lines
- Set active caller ID
Get available user lines
Get the list of all available lines a user can use as caller ID for outgoing calls.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Responses
Response samples
- 200
- 400
{- "line": [
- {
- "linetype": "PRIMARY_LINE",
- "number": "+123400",
- "name": "Business",
- "active": true
}, - {
- "linetype": "SWITCHBOARD",
- "number": "+120000",
- "name": "Switchboard",
- "active": false
}, - {
- "linetype": "FUNCTION_NUMBER",
- "number": "+123000",
- "name": "Support",
- "id": 11,
- "active": false
}, - {
- "linetype": "ANONYMOUS",
- "name": "Anonymous",
- "active": false
}
]
}Set active caller ID
Update the current active caller ID for a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Request Body schema: application/jsonrequired
| linetype required | string Enum: "PRIMARY_LINE" "SECONDARY_LINE" "SWITCHBOARD" "ANONYMOUS" "FUNCTION_NUMBER" Type of user line |
| id | integer <int64> The ID of the distribution group |
Responses
Request samples
- Payload
Primary line
{- "linetype": "PRIMARY_LINE"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Set active caller ID for users
Update the current active caller ID for a list of users, based on a priority ordered line type list.
For each user the first best match of line type will be set as caller ID.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/jsonrequired
Array of objects (UserLineDTO) List of available lines when GET is used. | |
| user | Array of strings List of usernames |
Responses
Request samples
- Payload
Multiple users
{- "line": [
- {
- "linetype": "SECONDARY_LINE"
}, - {
- "linetype": "FUNCTION_NUMBER",
- "id": 11
}, - {
- "linetype": "FUNCTION_NUMBER",
- "id": 12
}, - {
- "linetype": "SWITCHBOARD"
}
], - "user": [
- "user1",
- "user2",
- "user3",
- "user4",
- "user5",
- "",
- "user6",
- "user7",
- "user8"
]
}Response samples
- 200
- 400
{- "failedUsers": [
- "user2",
- "user6"
], - "invalidUsers": [
- "",
- "user8"
], - "nrOfFailedUsers": 2,
- "nrOfSuccessfulUsers": 5,
- "nrOfInvalidUsers": 2
}The ACD Group API is used to manage ACD group numbers.
Use the ACD Group API to:
- Create ACD groups
- Get ACD groups
- Update ACD groups
- Delete ACD groups
Update ACD group
Updates an ACD function number.
See API to create ACD group for possible error codes.
For example of values, please look into ACD Light and Attendant group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdFunctionNumber": {
- "id": 10,
- "name": "Acd Group 1",
- "phoneNumber": "+46899995006",
- "featureCodeIdentifier": "1122",
- "metadata": "Acd Group 1",
- "overrideMetadata": true,
- "userGroups": [
- "AcdUserGroup1"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "CALLING_PARTY",
- "groupNumberPrefix": "00",
- "callerIdLookup": false,
- "callbackTimeout": 20,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 2,
- "callbackToAgentMetadata": "Callback from ACD Group 1",
- "callbackToAgentPromptId": "system_beep",
- "callbackOfferPromptId": "system_activate_callback",
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "supervisorGroups": [
- "ACD supervisor"
], - "aliasOutboundNumber": "+46899995006",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "ACD Group 1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD group
Creates an ACD function number.
For example of values, please look into ACD Light and Attendant group as well.
Adding, removing or modifying an ACD function number can cause the following errors:
fnr.license.violation - Update failed because a required license was exceeded or has expired. The name element points out which license.
fnr.missing.name - The function number name is missing
fnr.missing.loggedInDistributionGroup.overflowAction - Missing OverFlow action
fnr.invalid.hourMinuteDuration - The time duration is not provided in the required format of "minutes[:seconds]"
fnr.missing.localizedValue.language - Language is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.missing.localizedValue.value - Value is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.featureCodeIdentifier.invalid - The feature code ID is already in use
int.value.invalid - The feature code ID must be an integer value greater than 0
fnr.number.inuse - The specified phone number is already in use
fnr.number.out.of.range - The specified phone number is outside of the number ranges of the organization
fnr.group.missing - The specified group is missing
fnr.group.invalid - The specified user group is invalid
fnr.value.required - This value is required
fnr.invalid.distribution - A specified device under distribution is not valid
fnr.invalid.callOnWait - Invalid value specified for max calls on wait
fnr.invalid.superCallOnWait - Invalid value specified for super max calls on wait
fnr.invalid.billingid - The specified billing ID is not within a configured billing range
fnr.invalid.prompt - Invalid prompt ID specified
invalid.value - A specified value is not valid
organization.invalid.asr.language - The language stated for an SAA alias is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - A name stated for an SAA alias contains unsupported characters for the language specified
missing.field - A mandatory field is missing
missing.license - A required license is missing
distributionGroup.queuePrio.disabled - A non-default priority order requires queue priority to be enabled
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdFunctionNumber": {
- "name": "Acd Group 1",
- "phoneNumber": "+46899995006",
- "featureCodeIdentifier": "1122",
- "metadata": "Acd Group 1",
- "overrideMetadata": true,
- "userGroups": [
- "AcdUserGroup1"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995006",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "FORWARD",
- "forwardNumberOnOverflow": "+46899995010",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "ACD Group 1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get ACD group
Fetches information about an ACD function number.
For example of values, please look into ACD Light and Attendant group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "acdFunctionNumber": {
- "id": 10,
- "name": "Acd Group 1",
- "phoneNumber": "+46899995006",
- "featureCodeIdentifier": "1122",
- "metadata": "Acd Group 1",
- "overrideMetadata": true,
- "userGroups": [
- "AcdUserGroup1"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "CALLING_PARTY",
- "groupNumberPrefix": "00",
- "callerIdLookup": false,
- "callbackTimeout": 20,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 2,
- "callbackToAgentMetadata": "Callback from ACD Group 1",
- "callbackToAgentPromptId": "system_beep",
- "callbackOfferPromptId": "system_activate_callback",
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "supervisorGroups": [
- "ACD supervisor"
], - "aliasOutboundNumber": "+46899995006",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "ACD Group 1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false
}
}Update ACD group Deprecated
Updates an ACD function number.
See API to create ACD group for possible error codes.
For example of values, please look into ACD Light and Attendant group as well.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdFunctionNumber": {
- "id": 10,
- "name": "Acd Group 1",
- "phoneNumber": "+46899995006",
- "featureCodeIdentifier": "1122",
- "metadata": "Acd Group 1",
- "overrideMetadata": true,
- "userGroups": [
- "AcdUserGroup1"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "CALLING_PARTY",
- "groupNumberPrefix": "00",
- "callerIdLookup": false,
- "callbackTimeout": 20,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 2,
- "callbackToAgentMetadata": "Callback from ACD Group 1",
- "callbackToAgentPromptId": "system_beep",
- "callbackOfferPromptId": "system_activate_callback",
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "supervisorGroups": [
- "ACD supervisor"
], - "aliasOutboundNumber": "+46899995006",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "ACD Group 1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD group Deprecated
Creates an ACD function number.
For example of values, please look into ACD Light and Attendant group as well.
Adding, removing or modifying an ACD function number can cause the following errors:
fnr.license.violation - Update failed because a required license was exceeded or has expired. The name element points out which license.
fnr.missing.name - The function number name is missing
fnr.missing.loggedInDistributionGroup.overflowAction - Missing OverFlow action
fnr.invalid.hourMinuteDuration - The time duration is not provided in the required format of "minutes[:seconds]"
fnr.missing.localizedValue.language - Language is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.missing.localizedValue.value - Value is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.featureCodeIdentifier.invalid - The feature code ID is already in use
int.value.invalid - The feature code ID must be an integer value greater than 0
fnr.number.inuse - The specified phone number is already in use
fnr.number.out.of.range - The specified phone number is outside of the number ranges of the organization
fnr.group.missing - The specified group is missing
fnr.group.invalid - The specified user group is invalid
fnr.value.required - This value is required
fnr.invalid.distribution - A specified device under distribution is not valid
fnr.invalid.callOnWait - Invalid value specified for max calls on wait
fnr.invalid.superCallOnWait - Invalid value specified for super max calls on wait
fnr.invalid.billingid - The specified billing ID is not within a configured billing range
fnr.invalid.prompt - Invalid prompt ID specified
invalid.value - A specified value is not valid
organization.invalid.asr.language - The language stated for an SAA alias is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - A name stated for an SAA alias contains unsupported characters for the language specified
missing.field - A mandatory field is missing
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdFunctionNumber": {
- "name": "Acd Group 1",
- "phoneNumber": "+46899995006",
- "featureCodeIdentifier": "1122",
- "metadata": "Acd Group 1",
- "overrideMetadata": true,
- "userGroups": [
- "AcdUserGroup1"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995006",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "FORWARD",
- "forwardNumberOnOverflow": "+46899995010",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "ACD Group 1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get ACD group Deprecated
Fetches the information of an ACD group.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 0,
- "fnr": "string",
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Update ACD group Deprecated
Updates ACD Group number.
See API to create ACD Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD group Deprecated
Adding, removing or modifying an ACD group can cause the following errors:
fnr.license.violation - Update failed because a required license was exceeded or has expired. The name element points out which license.
fnr.missing.name - Function number name is missing
fnr.missing.loggedInDistributionGroup.overflowAction - Missing OverFlow action
fnr.invalid.hourMinuteDuration - The time duration is not provided in the required format of "minutes[:seconds]"
fnr.missing.localizedValue.language - Language is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.missing.localizedValue.value - Value is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.featureCodeIdentifier.invalid - the feature code ID is already in use
int.value.invalid - the feature code ID must be an integer value greater than 0
fnr.number.inuse - not possible to create a new group with the number as it is alreadyin use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.group.missing - the specified group is missing
fnr.invalid.distribution - a specified device under distribution is not valid
fnr.invalid.statsPeriod - invalid value for statistics period
fnr.invalid.callOnWait - invalid value for max calls on wait
fnr.invalid.superCallOnWait - invalid value for super max calls on wait
fnr.invalid.prompt - invalid prompt id
organization.invalid.asr.language - the language id stated in an saaAlias instance is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - the names stated in an saaAlias instance contain unsupported characters for the language specified
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
query Parameters
| autoLogin | boolean |
Request Body schema: required
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete ACD group Deprecated
Removes an ACD Group.
See API to create ACD Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
The ACD Light Group API is used to manage ACD light group numbers.
Use the ACD Light Group API to:
- Create ACD light groups
- Get ACD light groups
- Update ACD light groups
- Delete ACD light groups
Update ACD Light group
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and Attendant group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdLightFunctionNumber": {
- "id": 11,
- "name": "AcdLight",
- "phoneNumber": "+46899995007",
- "featureCodeIdentifier": "2233",
- "userGroups": [
- "AcdLightAgents"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": false,
- "distribution": [
- "SOFTPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "overrideCallRecordingSettings": true,
- "overrideCallRecordingGroup": "AcdLightAgents",
- "overrideCallRecordingOutbound": false,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995007",
- "allowUsingFunctionNumber": false,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995007",
- "callSetupTimeout": 30,
- "maxCallsOnWait": 10,
- "superMaxCallsOnWait": 5,
- "overflowAction": "PLAY_PROMPT",
- "overflowPrompt": "23452233355",
- "progressPrompt": "system_silence",
- "progressInterval": 20,
- "maxCallWaitTime": "10:00",
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 3,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": false,
- "distributionType": "PRIORITY",
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD Light group
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and Attendant group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdLightFunctionNumber": {
- "name": "AcdLight",
- "phoneNumber": "+46899995007",
- "featureCodeIdentifier": "2233",
- "userGroups": [
- "AcdLightAgents"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": false,
- "distribution": [
- "SOFTPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995007",
- "allowUsingFunctionNumber": false,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995007",
- "callSetupTimeout": 30,
- "maxCallsOnWait": 10,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "progressPrompt": "system_silence",
- "progressInterval": 20,
- "maxCallWaitTime": "10:00",
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 3,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": false,
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get ACD Light group
For example of values, please look into ACD and Attendant group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "acdLightFunctionNumber": {
- "id": 11,
- "name": "AcdLight",
- "phoneNumber": "+46899995007",
- "featureCodeIdentifier": "2233",
- "userGroups": [
- "AcdLightAgents"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": false,
- "distribution": [
- "SOFTPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "overrideCallRecordingSettings": true,
- "overrideCallRecordingGroup": "AcdLightAgents",
- "overrideCallRecordingOutbound": false,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995007",
- "allowUsingFunctionNumber": false,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995007",
- "callSetupTimeout": 30,
- "maxCallsOnWait": 10,
- "superMaxCallsOnWait": 5,
- "overflowAction": "PLAY_PROMPT",
- "overflowPrompt": "23452233355",
- "progressPrompt": "system_silence",
- "progressInterval": 20,
- "maxCallWaitTime": "10:00",
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 3,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": false,
- "distributionType": "PRIORITY",
- "useInternalNumber": true
}
}Update ACD Light group Deprecated
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and Attendant group as well.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdLightFunctionNumber": {
- "id": 11,
- "name": "AcdLight",
- "phoneNumber": "+46899995007",
- "featureCodeIdentifier": "2233",
- "userGroups": [
- "AcdLightAgents"
], - "barringGroups": [
- "Barring1",
- "Barring2"
], - "excludeFromSearch": false,
- "distribution": [
- "SOFTPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "overrideCallRecordingSettings": true,
- "overrideCallRecordingGroup": "AcdLightAgents",
- "overrideCallRecordingOutbound": false,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995007",
- "allowUsingFunctionNumber": false,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995007",
- "callSetupTimeout": 30,
- "maxCallsOnWait": 10,
- "superMaxCallsOnWait": 5,
- "overflowAction": "PLAY_PROMPT",
- "overflowPrompt": "23452233355",
- "progressPrompt": "system_silence",
- "progressInterval": 20,
- "maxCallWaitTime": "10:00",
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 3,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": false,
- "distributionType": "PRIORITY",
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD Light group Deprecated
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and Attendant group as well.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "acdLightFunctionNumber": {
- "name": "AcdLight",
- "phoneNumber": "+46899995007",
- "featureCodeIdentifier": "2233",
- "userGroups": [
- "AcdLightAgents"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": false,
- "distribution": [
- "SOFTPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995007",
- "allowUsingFunctionNumber": false,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995007",
- "callSetupTimeout": 30,
- "maxCallsOnWait": 10,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "progressPrompt": "system_silence",
- "progressInterval": 20,
- "maxCallWaitTime": "10:00",
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 3,
- "concurrentAgentsPerDistribution": 1,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": false,
- "useInternalNumber": true
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get ACD Light group Deprecated
Fetches the information of an ACD Light group
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 0,
- "fnr": "string",
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Update ACD Light group Deprecated
See API to create ACD Light Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema:
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create ACD Light group Deprecated
Adding, removing or modifying an ACD Light group can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.missing.loggedInDistributionGroup.overflowAction - Missing OverFlow action
fnr.invalid.hourMinuteDuration - The time duration is not provided in the required format of "minutes[:seconds]"
fnr.missing.localizedValue.language - Language is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.missing.localizedValue.value - Value is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.featureCodeIdentifier.invalid - the feature code ID is already in use
int.value.invalid - the feature code ID must be an integer value greater than 0
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.group.missing - the specified group is missing
fnr.invalid.distribution - a specified device under distribution is not valid
fnr.invalid.callOnWait - invalid value for max calls on wait
fnr.invalid.superCallOnWait - invalid value for super max calls on wait
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.invalid.prompt - invalid prompt id
organization.invalid.asr.language - the language id stated in an saaAlias instance is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - the names stated in an saaAlias instance contain unsupported characters for the language specified
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
query Parameters
| autoLogin | boolean |
Request Body schema:
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete ACD Light group Deprecated
See API to create ACD Light Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
The Attendant Group API is used to manage attendant group numbers.
Use the Attendant Group API to:
- Create attendant groups
- Get attendant groups
- Update attendant groups
- Delete attendant groups
Update Attendant group
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and ACD Light group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "attendantFunctionNumber": {
- "id": 15,
- "name": "Attendant",
- "phoneNumber": "+46899995001",
- "featureCodeIdentifier": "3344",
- "metadata": "Attendant",
- "overrideMetadata": true,
- "userGroups": [
- "Attendants"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "excludeFromSAASearch": false,
- "saaSearchAliases": [
- {
- "value": "Attendant",
- "language": "en"
}, - {
- "value": "Telefonist",
- "language": "sv"
}
], - "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995101",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 2,
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "FORWARD",
- "forwardNumberOnOverflow": "+46899995010",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "Attendant1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false,
- "saaProfileId": 0,
- "callTaker": "AGENT",
- "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 15,
- "alertAttendantGroupAfterCampOnSeconds": 30,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 30
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Attendant group
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and ACD Light group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "attendantFunctionNumber": {
- "name": "Attendant",
- "phoneNumber": "+46899995001",
- "featureCodeIdentifier": "3344",
- "metadata": "Attendant",
- "overrideMetadata": true,
- "userGroups": [
- "Attendants"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995001",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "Attendant",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "SKILLS",
- "useInternalNumber": true,
- "callTaker": "AGENT",
- "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 60,
- "alertAttendantGroupAfterCampOnSeconds": 120,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 30
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get Attendant group
Fetches information about an Attendant function number.
For example of values, please look into ACD and ACD Light group as well.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "attendantFunctionNumber": {
- "id": 15,
- "name": "Attendant",
- "phoneNumber": "+46899995001",
- "featureCodeIdentifier": "3344",
- "metadata": "Attendant",
- "overrideMetadata": true,
- "userGroups": [
- "Attendants"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "excludeFromSAASearch": false,
- "saaSearchAliases": [
- {
- "value": "Attendant",
- "language": "en"
}, - {
- "value": "Telefonist",
- "language": "sv"
}
], - "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995101",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 2,
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "FORWARD",
- "forwardNumberOnOverflow": "+46899995010",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "Attendant1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false,
- "saaProfileId": 0,
- "callTaker": "AGENT",
- "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 15,
- "alertAttendantGroupAfterCampOnSeconds": 30,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 30
}
}Update Attendant group Deprecated
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and ACD Light group as well.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "attendantFunctionNumber": {
- "id": 15,
- "name": "Attendant",
- "phoneNumber": "+46899995001",
- "featureCodeIdentifier": "3344",
- "metadata": "Attendant",
- "overrideMetadata": true,
- "userGroups": [
- "Attendants"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "excludeFromSAASearch": false,
- "saaSearchAliases": [
- {
- "value": "Attendant",
- "language": "en"
}, - {
- "value": "Telefonist",
- "language": "sv"
}
], - "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995101",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 2,
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "FORWARD",
- "forwardNumberOnOverflow": "+46899995010",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "Attendant1",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "PRIORITY",
- "useInternalNumber": false,
- "saaProfileId": 0,
- "callTaker": "AGENT",
- "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 15,
- "alertAttendantGroupAfterCampOnSeconds": 30,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 30
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Attendant group Deprecated
See API to create ACD function number for possible error codes.
For example of values, please look into ACD and ACD Light group as well.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
query Parameters
| autoLogin | boolean Users in the group will be logged in immediately if set to true |
Request Body schema: application/jsonrequired
object (AcdFunctionNumberDTO) Applicable for ACD group operations | |
object (AcdLightFunctionNumberDTO) Applicable for ACD Light group operations | |
object (AttendantFunctionNumberDTO) Applicable for Attendant group operations |
Responses
Request samples
- Payload
{- "attendantFunctionNumber": {
- "name": "Attendant",
- "phoneNumber": "+46899995001",
- "featureCodeIdentifier": "3344",
- "metadata": "Attendant",
- "overrideMetadata": true,
- "userGroups": [
- "Attendants"
], - "barringGroups": [
- "Barring1"
], - "excludeFromSearch": true,
- "distribution": [
- "SOFTPHONE",
- "DESKPHONE"
], - "preferredNumberType": "DIVERSION_NUMBER",
- "callerIdLookup": false,
- "callbackTimeout": 0,
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 15,
- "callbackOfferAfterEstimatedWaitTime": 15,
- "callbackValidityTimeout": 0,
- "callbackRetries": 0,
- "onlyDistributeCallsToLoggedIn": true,
- "checkPresenceOnDistribution": true,
- "aliasOutboundNumber": "+46899995001",
- "allowUsingFunctionNumber": true,
- "forwardNumberOnNoAgentsLoggedIn": "+46899995010",
- "billingId": "+46899995000",
- "sourceTag": "Caller-Source",
- "helpNumber": "+46899995050",
- "missedCallsLogoutThreshold": 0,
- "restingTimeSeconds": 15,
- "callSetupTimeout": 20,
- "useLongestIdle": true,
- "maxCallsOnWait": 5,
- "superMaxCallsOnWait": 5,
- "overflowAction": "BUSY",
- "enterQueuePrompt": "system_placed_in_queue",
- "playInQueuePrompt": "system_still_placed_in_queue",
- "progressPrompt": "system_placed_in_queue",
- "progressInterval": 30,
- "statisticsPeriod": 30,
- "maxCallWaitTime": "10:00",
- "smsSenderIdentity": "Attendant",
- "smsSenderNumber": "",
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 5,
- "maxQueueWaitTime": 30,
- "forwardNumberOnPlacedOnQueueTimeout": "+46899995050",
- "placedOnQueueTimeout": "5:00",
- "maxAgentDistributions": 10,
- "concurrentAgentsPerDistribution": 2,
- "playRingingDuringDistribution": true,
- "ignoreInitialDiversion": true,
- "distributionType": "SKILLS",
- "useInternalNumber": true,
- "callTaker": "AGENT",
- "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 60,
- "alertAttendantGroupAfterCampOnSeconds": 120,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 30
}
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get Attendant group Deprecated
Fetch the information of an Attendant group.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 0,
- "fnr": "string",
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
], - "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 0,
- "alertAttendantGroupAfterCampOnSeconds": 0,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 0,
- "callTaker": "AGENT",
- "saaProfileId": 0
}Update Attendant group Deprecated
See API to create ACD Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema:
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
| campOnEnabled | boolean |
| alertAttendantAfterCampOnSeconds | integer <int32> |
| alertAttendantGroupAfterCampOnSeconds | integer <int32> |
| returnToQueueOnFailedCampOn | boolean |
| trySameAttendantAfterFailedCampOnSeconds | integer <int32> |
| callTaker | string Enum: "AGENT" "SAA" |
| saaProfileId | integer <int32> |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
], - "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 0,
- "alertAttendantGroupAfterCampOnSeconds": 0,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 0,
- "callTaker": "AGENT",
- "saaProfileId": 0
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Attendant group Deprecated
See API to create ACD Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
query Parameters
| autoLogin | boolean |
Request Body schema:
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| overflowAction required | string (Mandatory field for PUT/POST) A string with either BUSY or FORWARD depending on the preferred action if maxCallsOnWait or maxQueueWaitTime is exceeded. |
| restingTimeSeconds required | integer <int32> Default: -1 The minimum time in seconds that the system should wait until the next call is distributed to the agent after a call has been hung up. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects A collection of names by which this group number is recognized by Speech Auto Attendant services. | |
| onlyDistributeCallsToLoggedIn | boolean (Mandatory field for PUT/POST) if true, calls will only be distributed to agents logged in to the acd or attendant group. |
| forwardNrWhenNoAgentsLoggedIn | string Number to forward to when no agents are logged in. |
| checkPresenceOnDistribution | boolean (Mandatory field for PUT/POST) Boolean if distribution is only to agents in the Available state. This should be true if calls should be forwarded to a fallback number if the presence state has changed. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| sourceTag | string |
| queuePriorityEnabled | boolean Boolean if queue can be given a priority order. If false, the queue is given a default priority. |
| queuePriorityOrder | integer <int32> Default: 5 The queue priority order is used to prioritize queues in the organization. |
| missedCallsLogoutThreshold | integer <int32> The amount of calls an agent is allowed to miss before being automatically logged out. |
| callSetupTimeout | integer <int32> (Mandatory field for PUT/POST) The call setup timeout in seconds. |
| useLongestIdle | boolean Boolean if longest idle distribution shall be used for agents with equal skills. If false, randomised distribution is used. |
| maxCallsOnWait | integer <int32> (Mandatory field for PUT/POST) The amount of calls that are allowed to be waiting in the queue for the dialed number. Each call in queue takes up one media resource. |
| superMaxCallsOnWait | integer <int32> The maximum value an organization admin is allowed to set in max-CallsOnWait. |
| maxCallWaitTime | string The amount of minutes (mandatory) and seconds (optional) of waiting time for the caller first in queue until the queue is set as full. Enter time as minutes:seconds, or only as minutes. |
| forwardNumberOnOverflow | string Number to forward to when queue is full or max wait time has been exceeded. |
| progressInterval | integer <int32> (Mandatory field for PUT/POST) The number of seconds that a queue message should be repeated after being played. If there is no progress message, a zero, 0, is entered. |
| forwardNumberOnPlacedOnQueueTimeout | string Number to forward to when call has been in queue unanswered for duration specified by placedOnQueueTimeout. |
| placedOnQueueTimeout | string The amount of minutes (mandatory) and seconds (optional) that a call may stay unanswered before forwarded to the number specified by forwardNumberOnPlacedOnQueueTimeout. Enter time as minutes:seconds, or only as minutes. |
| playRingingDuringDistribution | boolean (Mandatory field for PUT/POST) Boolean if a ringing tone shall be played for caller in queue when call is ringing on agents phone. If false, normal queue and progress will continue. |
| maxAgentDistributions | integer <int32> (Mandatory field for PUT/POST) Maximum number of distribution attempts before forwarding to no agents number. |
| concurrentAgentsPerDistribution | integer <int32> (Mandatory field for PUT/POST) Number of agents that receives call in parallel. If no agent is answering acd will continue to a new parallel set of agents. |
| alternateProgressQueuePosTime | boolean Boolean if the voice prompts should alternate between progress message and queue position/waiting time. |
| playQueuePos | boolean Boolean value if queue position is played while waiting in queue. |
| playQueueWaitTime | boolean Boolean value if queue waiting time is played while waiting in queue. |
| minQueueWaitTime | integer <int32> The minimum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is shorter than the set minimum time, no waiting time prompt is played for the calling part. |
| maxQueueWaitTime | integer <int32> The maximum time in minutes where queue waiting time is played for the calling part. If the queue waiting time is longer than the set maximum time, no waiting time prompt is played for the calling part. |
| statisticsPeriod | integer <int32> (Mandatory field for PUT/POST) The amount of minutes for the statistics period for the Supervisor widget. |
| distributionType | string Enum: "PRIORITY" "SKILLS" (Mandatory field for PUT/POST) Can be set to either PRIORITY to distribute the call to a single receiver at a time according to a distribution list, or SKILLS to distribute the call to a single or several receivers according to a list of receivers with a priority value ("skill level"). If several receivers have the same "skill level" and are free to take the call, they will all receive it if concurrentAgentsPerDistribution allows it. |
| smsSenderIdentity | string A string with the display name to use when sending SMS from this number (empty=don't allow sending). |
| smsSenderNumber | string |
| ignoreInitialDiversion | boolean (Mandatory field for PUT/POST) Boolean setting whether to override the initial diversion. Can either be true or false. |
| callbackTimeout | integer <int32> The timeout in seconds for each callback retry (Integer) before re-queuing the caller. |
| callbackRetries | integer <int32> The number of callback retries (Integer) that will be performed. If set to zero (0), the callback function is disabled. |
| callbackValidityTimeout | integer <int32> The timeout in minutes (Integer) for queued calls that requested a callback. After this time, the callback will be cancelled. If set to zero (0), there is no cancellation timeout. |
| callbackToAgentMetadata | string The text message (String) to display to the Agent upon callback. |
| callbackToAgentPromptId | string The voice prompt ID to play to agent at a callback call. |
| callbackOfferAfterOpen | integer <int32> The time passed since the queue is open. Within this time, the callback is not offered. |
| callbackOfferBeforeClose | integer <int32> The time in minutes left to the queue closing time. Within this time, the callback is not offered. |
| callbackOfferAfterXCallsInQueue | integer <int32> The amount of calls that must be waiting in the queue before callbacks are offered. |
| callbackOfferAfterLongestWaitTime | integer <int32> The longest queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferAfterEstimatedWaitTime | integer <int32> The estimated current queue waiting time in minutes to offer the callback. Disabled if set to zero (0). Not applicable for ACD Light numbers. |
| callbackOfferPromptId | string The voice prompt ID to play when a callback choice is offered to the caller. |
| aliasOutboundNumber | string Alias number used when a call is made using the distribution group as active caller id. |
| allowUsingFunctionNumber | boolean Boolean whether to allow users that belong to this distribution group to use the group number(or alias number, if set) as outbound line. Can be true or false. |
| useInternalNumber | boolean |
| retainLocaleOnCallForward | boolean |
| supervisorHelpNumber | string supervisorHelpNumber |
| enterQueuePrompt | string (Mandatory field for PUT/POST) A string with the voice prompt ID that
should be played when entering queue. If no voice prompt is wanted, leave the XML-tag
blank ( |
| overflowPrompt | string A string with the voice prompt ID that should be played when queue is overflowed. Mandatory for PUT/POST if overflow action is PLAY_PROMPT. |
| playInQueuePrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| progressPrompt | string (Mandatory field for PUT/POST) The voice prompt ID to play as progress message while in queue. If no voice prompt is wanted, leave the XML-tag blank ( |
| supervisorGroups | Array of strings The element is present when fetching, but cannot be changed for ACD light groups. |
| campOnEnabled | boolean |
| alertAttendantAfterCampOnSeconds | integer <int32> |
| alertAttendantGroupAfterCampOnSeconds | integer <int32> |
| returnToQueueOnFailedCampOn | boolean |
| trySameAttendantAfterFailedCampOnSeconds | integer <int32> |
| callTaker | string Enum: "AGENT" "SAA" |
| saaProfileId | integer <int32> |
Responses
Request samples
- Payload
{- "id": 0,
- "name": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "excludeFromSearch": true,
- "preferredNumberType": "DIVERSION_NUMBER",
- "groupNumberPrefix": "string",
- "groupNumberSuffix": "string",
- "featureCodeIdentifier": "string",
- "groups": [
- "string"
], - "distribution": [
- "string"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "string",
- "language": "string"
}
], - "onlyDistributeCallsToLoggedIn": true,
- "forwardNrWhenNoAgentsLoggedIn": "string",
- "checkPresenceOnDistribution": true,
- "billingId": "string",
- "sourceTag": "string",
- "queuePriorityEnabled": true,
- "queuePriorityOrder": 5,
- "restingTimeSeconds": -1,
- "missedCallsLogoutThreshold": 0,
- "callSetupTimeout": 0,
- "useLongestIdle": true,
- "maxCallsOnWait": 0,
- "superMaxCallsOnWait": 0,
- "maxCallWaitTime": "string",
- "overflowAction": "string",
- "forwardNumberOnOverflow": "string",
- "progressInterval": 0,
- "forwardNumberOnPlacedOnQueueTimeout": "string",
- "placedOnQueueTimeout": "string",
- "playRingingDuringDistribution": true,
- "maxAgentDistributions": 0,
- "concurrentAgentsPerDistribution": 0,
- "alternateProgressQueuePosTime": true,
- "playQueuePos": true,
- "playQueueWaitTime": true,
- "minQueueWaitTime": 0,
- "maxQueueWaitTime": 0,
- "statisticsPeriod": 0,
- "distributionType": "PRIORITY",
- "smsSenderIdentity": "string",
- "smsSenderNumber": "string",
- "ignoreInitialDiversion": true,
- "callbackTimeout": 0,
- "callbackRetries": 0,
- "callbackValidityTimeout": 0,
- "callbackToAgentMetadata": "string",
- "callbackToAgentPromptId": "string",
- "callbackOfferAfterOpen": 0,
- "callbackOfferBeforeClose": 0,
- "callbackOfferAfterXCallsInQueue": 0,
- "callbackOfferAfterLongestWaitTime": 0,
- "callbackOfferAfterEstimatedWaitTime": 0,
- "callbackOfferPromptId": "string",
- "aliasOutboundNumber": "string",
- "allowUsingFunctionNumber": true,
- "useInternalNumber": true,
- "retainLocaleOnCallForward": true,
- "supervisorHelpNumber": "string",
- "enterQueuePrompt": "string",
- "overflowPrompt": "string",
- "playInQueuePrompt": "string",
- "progressPrompt": "string",
- "supervisorGroups": [
- "string"
], - "campOnEnabled": true,
- "alertAttendantAfterCampOnSeconds": 0,
- "alertAttendantGroupAfterCampOnSeconds": 0,
- "returnToQueueOnFailedCampOn": true,
- "trySameAttendantAfterFailedCampOnSeconds": 0,
- "callTaker": "AGENT",
- "saaProfileId": 0
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete Attendant group Deprecated
See API to create ACD Group for possible error codes.
NOTE: This method is DEPRECATED and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
The Auto Attendant API is used to manage Auto Attendant numbers.
Use the Auto Attendant API to:
- List Auto Attendant numbers
- Get Auto Attendant number
- Get Auto Attendant tree node
- Create Auto Attendant number
- Create Auto Attendant tree root node
- Create Auto Attendant tree node
- Update Auto Attendant number
- Update Auto Attendant tree node
- Delete Auto Attendant number
- Delete Auto Attendant tree node
Create tree node Deprecated
See API to create AutoAttendant Number for possible error codes.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
Request Body schema: required
| forwardNumberForCollectedDigits required | string If the node type is COLLECT_DIGITS, this is the phone number to which the call is forwarded after the digits are collected. The forwarded call carries the collected digits |
| id | string The id of the auto attendant number. For child nodes, the id of the child node. |
| name | string The name of the auto attendant number. For child nodes, it is the name of the child node. |
| description | string A textual description of the auto attendant number. For child nodes, the description of the child node. |
| fnr | string The auto attendant telephone number. |
| parentMenuNodeId | string The id of the parent node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node id to return to. The auto attendant call will continue executing at this node if the transfer fails. |
| keyNumber | string The dtmf key of the parent node the child node is attached to. |
| type | string Enum: "PLAY_MESSAGE" "MENU_NODE" "DIAL_NUMBER" "DIAL_USER" "DIAL_GROUP" "LEAVE_MESSAGE" "EXTENSION_NODE" "DIAL_BY_NAME" "BILINGUAL_NODE" "ASR" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "CALL_RECORDING_CONSENT_NODE" The type of the node. For the root node, this is always MENU_NODE. The type of the child node can be any of MENU_NODE, DIAL_NUMBER, EXTENSION_NODE, PLAY_MESSAGE, DIAL_BY_NAME. |
| phoneNumber | string If the node type is DIAL_NUMBER, this is the phone number to dial and transfer to. |
| promptId | string The prompt to play when entering this state. It's contents and purpose will vary depending on the node type, as follows: PLAY_MESSAGE - the message prompt to play. Typically containing information of some sort, e.g. opening hours. DIAL_NUMBER - the prompt to play before dialling a phone number. EXTENSION_NODE - the prompt is used to tell the user to enter the extension to which the call should be forwarded. DIAL_BY_NAME - the prompt is used to tell the caller to enter the first n digits of the name of the person to whom the call should be transferred. MENU_NODE - the prompt is used to present the available menu options. COLLECT_DIGITS - the prompt is used to tell the caller to enter the digits. When collected, the digits entered are forwarded along with the call. |
| numberOfTimesToPlay | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the number of times the prompt should be played when not receiving any input. |
| digitTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the time to wait before taking action when not receiving any input. |
| forwardNumberOnTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE and COLLECT_DIGITS. When set and timeout fires, the menu will not be played again. Instead the caller is forwarded to the number configured here. |
| transferringPromptId | string If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is the prompt id to play before transferring the call to an extension or a user located by name. The prompt will be combined with the extension or name of the searched target. If dialling an extension, the extension is appended after the prompt; if dialling by name, the order of the combination is determined by transferringPromptPosition. |
| unavailablePromptId | string If the node type is EXTENSION_NODE, this is the prompt id to play if an invalid extension has been entered. |
| nameType | string For DIAL_BY_NAME nodes, the type of name against which the entered digits should be matched. Valid values are FIRSTNAME or LASTNAME. |
| dialByNameDigits | string If the node type is DIAL_BY_NAME, this is the amount of digits the caller will be expected to provide to perform a search for matching names. |
| transferringPromptPosition | string If the node type is DIAL_BY_NAME, this controls the position of the transferringPromptId in relation to the name prompt of the assumed target user. Valid values are BEFORE and AFTER. For example, if the positon is AFTER, a combination could sound "Emma Jones - one moment please". If there is no name prompt for the target user, only the transfer prompt is played. |
| selectionPromptId | string For DIAL_BY_NAME nodes where there is more than one possibility and there is a selectionKey defined, the purpose of this prompt is to inform the caller that the possible targets will be presented and which key he should press when the correct target is presented. |
| selectionKey | string If the node type is DIAL_BY_NAME, the entered digits could match more than one possible target (e.g. J O A can be either Joan or Joanna). If there are severalmatches and a selectionKey defined, the matches will be presented and the caller asked to press this key to confirm the correct target. If no key is defined, the first alphabetically matching person will be the assumed target. |
| numberOfDigitsToCollect | string If the node type is COLLECT_DIGITS, this is the number of digits to collect before forwarding the call.The key '#' is used to end the digit collection if this setting is not configured or its value is 0. |
| appendDigitsToDisplayName | boolean If the node type is COLLECT_DIGITS and this boolean is set, the collected digits are appended to the displayname before the call is forwarded. If the node metadata is configured then the collected digits are prefixed with node metadata and the result is appended to the displayname. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| metadata | string A string with the meta data of the auto attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string A telephone number to an operator that the user will be transferred to when pressing humanAssistanceKey. |
| humanAssistancePromptId | string The id of the prompt that is to be played before transferring to an operator. |
| groups | Array of strings If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is a list of group elements. List of User group names containing the users that can be reached with extension or name dialling. |
| functionNumbers | Array of strings If the node type is EXTENSION_NODE, this is a list of functionNumber elements. List of function numbers that can be reached with extension dialling. |
Responses
Request samples
- Payload
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "auto_attendant_dial_a_number",
- "description": "Main Attendant",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "3",
- "type": "DIAL_NUMBER",
- "phoneNumber": "0923492742",
- "promptId": "system_busy_greeting"
}Response samples
- 200
- 400
{- "id": "12-3-6"
}Create tree node
Creates a node in Auto Attendant tree. It is required that the root node is created before creating any other nodes. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
Request Body schema: application/jsonrequired
| type required | string Enum: "MENU_NODE" "PLAY_MESSAGE" "DIAL_NUMBER" "DIAL_USER" "EXTENSION_NODE" "DIAL_BY_NAME" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "SPEECH_AUTO_ATTENDANT" "CALL_RECORDING_CONSENT" The type of the node. |
| id | string The ID of the node. When creating a node, this attribute is not applicable. |
| name | string The name of the node. |
| description | string The description of the node. |
| parentMenuNodeId | string The ID of the parent node. When creating a root node, this attribute is not applicable. |
| keyNumber | string The DTMF key of the parent node the child node is attached to. When creating a root node, this attribute is not applicable. |
| nodeMetadata | string A string with the meta data of the node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node ID to return to. The Auto Attendant call will continue executing at this node if the transfer fails. This field is not applicable when the node type is API_INTEGRATION_NODE or COLLECT_DIGITS with actionAfterDigitsCollection as INVOKE_API. |
| isEditable | boolean This is set to true if the node is editable. |
| isDeletable | boolean This is set to true if the node is deletable. |
object (MenuNodeV2DTO) The details of menu node if the node is of type MENU_NODE. | |
object (DialNumberNodeDTO) The details of dial number node if the node is of type DIAL_NUMBER. | |
object (PlayMessageDTO) The details of play message node if the node is of type PLAY_MESSAGE. | |
object (CollectDigitsDTO) The details of collect digits node if the node is of type COLLECT_DIGITS. | |
object (ExtensionNodeDTO) The details of extension node if the node is of type EXTENSION_NODE. | |
object (DialByNameNodeDTO) The details of dial by name node if the node is of type DIAL_BY_NAME. | |
object (APIIntegrationNodeDTO) The details of API integration node if the node is of type API_INTEGRATION_NODE. | |
object (SAANodeDTO) The details of Speech Auto Attendant node if the node is of type SPEECH_AUTO_ATTENDANT. | |
object (CallRecordingConsentNodeDTO) The details of Call recording consent node if the node is of type CALL_RECORDING_CONSENT. |
Responses
Request samples
- Payload
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "Dial a number",
- "description": "Dials configured number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "5",
- "type": "DIAL_NUMBER",
- "isEditable": true,
- "isDeletable": true,
- "dialNumberNode": {
- "promptId": "system_busy_greeting",
- "phoneNumber": "+46923492742"
}
}Response samples
- 200
- 400
{- "id": "12-3-6"
}Create tree root node
Creates a root node. A root node may be of type DIAL_A_NUMBER, DIAL_BY_NAME, EXTENSION, MENU, PLAY_MESSAGE, COLLECT_DIGITS, or API_INTEGRATION_NODE. The root node must be created before creating any other nodes. To modify root node use update tree node API. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The Auto Attendant function number |
Request Body schema: application/jsonrequired
| type required | string Enum: "MENU_NODE" "PLAY_MESSAGE" "DIAL_NUMBER" "DIAL_USER" "EXTENSION_NODE" "DIAL_BY_NAME" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "SPEECH_AUTO_ATTENDANT" "CALL_RECORDING_CONSENT" The type of the node. |
| id | string The ID of the node. When creating a node, this attribute is not applicable. |
| name | string The name of the node. |
| description | string The description of the node. |
| parentMenuNodeId | string The ID of the parent node. When creating a root node, this attribute is not applicable. |
| keyNumber | string The DTMF key of the parent node the child node is attached to. When creating a root node, this attribute is not applicable. |
| nodeMetadata | string A string with the meta data of the node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node ID to return to. The Auto Attendant call will continue executing at this node if the transfer fails. This field is not applicable when the node type is API_INTEGRATION_NODE or COLLECT_DIGITS with actionAfterDigitsCollection as INVOKE_API. |
| isEditable | boolean This is set to true if the node is editable. |
| isDeletable | boolean This is set to true if the node is deletable. |
object (MenuNodeV2DTO) The details of menu node if the node is of type MENU_NODE. | |
object (DialNumberNodeDTO) The details of dial number node if the node is of type DIAL_NUMBER. | |
object (PlayMessageDTO) The details of play message node if the node is of type PLAY_MESSAGE. | |
object (CollectDigitsDTO) The details of collect digits node if the node is of type COLLECT_DIGITS. | |
object (ExtensionNodeDTO) The details of extension node if the node is of type EXTENSION_NODE. | |
object (DialByNameNodeDTO) The details of dial by name node if the node is of type DIAL_BY_NAME. | |
object (APIIntegrationNodeDTO) The details of API integration node if the node is of type API_INTEGRATION_NODE. | |
object (SAANodeDTO) The details of Speech Auto Attendant node if the node is of type SPEECH_AUTO_ATTENDANT. | |
object (CallRecordingConsentNodeDTO) The details of Call recording consent node if the node is of type CALL_RECORDING_CONSENT. |
Responses
Request samples
- Payload
DIAL_A_NUMBER
{- "name": "Dial a number",
- "description": "Dials configured number",
- "keyNumber": "5",
- "type": "DIAL_NUMBER",
- "isEditable": true,
- "isDeletable": true,
- "dialNumberNode": {
- "promptId": "system_busy_greeting",
- "phoneNumber": "+46923492742"
}
}Response samples
- 200
- 400
{- "id": "12-3-6"
}Get number Deprecated
Fetches an Auto Attendant number.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": "2-10-1",
- "name": "AutoAttendant",
- "description": "Example",
- "fnr": "+123400",
- "type": "MENU_NODE",
- "promptId": "system_silence",
- "numberOfTimesToPlay": "1",
- "digitTimeout": "5",
- "barringGroups": [ ],
- "overrideMetadata": false,
- "keyAssignments": { },
- "aaNodes": [
- {
- "id": "2-10-3",
- "name": "Dial",
- "description": "",
- "parentMenuNodeId": "2-10-1",
- "keyNumber": "1",
- "type": "DIAL_NUMBER",
- "phoneNumber": "12345",
- "promptId": "system_silence"
}, - {
- "id": "2-10-4",
- "name": "Message",
- "description": "",
- "parentMenuNodeId": "2-10-1",
- "keyNumber": "2",
- "type": "PLAY_MESSAGE",
- "promptId": "system_lunch_greeting"
}
]
}Update number Deprecated
See API to create AutoAttendant Number for possible error codes.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| forwardNumberForCollectedDigits required | string If the node type is COLLECT_DIGITS, this is the phone number to which the call is forwarded after the digits are collected. The forwarded call carries the collected digits |
| id | string The id of the auto attendant number. For child nodes, the id of the child node. |
| name | string The name of the auto attendant number. For child nodes, it is the name of the child node. |
| description | string A textual description of the auto attendant number. For child nodes, the description of the child node. |
| fnr | string The auto attendant telephone number. |
| parentMenuNodeId | string The id of the parent node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node id to return to. The auto attendant call will continue executing at this node if the transfer fails. |
| keyNumber | string The dtmf key of the parent node the child node is attached to. |
| type | string Enum: "PLAY_MESSAGE" "MENU_NODE" "DIAL_NUMBER" "DIAL_USER" "DIAL_GROUP" "LEAVE_MESSAGE" "EXTENSION_NODE" "DIAL_BY_NAME" "BILINGUAL_NODE" "ASR" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "CALL_RECORDING_CONSENT_NODE" The type of the node. For the root node, this is always MENU_NODE. The type of the child node can be any of MENU_NODE, DIAL_NUMBER, EXTENSION_NODE, PLAY_MESSAGE, DIAL_BY_NAME. |
| phoneNumber | string If the node type is DIAL_NUMBER, this is the phone number to dial and transfer to. |
| promptId | string The prompt to play when entering this state. It's contents and purpose will vary depending on the node type, as follows: PLAY_MESSAGE - the message prompt to play. Typically containing information of some sort, e.g. opening hours. DIAL_NUMBER - the prompt to play before dialling a phone number. EXTENSION_NODE - the prompt is used to tell the user to enter the extension to which the call should be forwarded. DIAL_BY_NAME - the prompt is used to tell the caller to enter the first n digits of the name of the person to whom the call should be transferred. MENU_NODE - the prompt is used to present the available menu options. COLLECT_DIGITS - the prompt is used to tell the caller to enter the digits. When collected, the digits entered are forwarded along with the call. |
| numberOfTimesToPlay | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the number of times the prompt should be played when not receiving any input. |
| digitTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the time to wait before taking action when not receiving any input. |
| forwardNumberOnTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE and COLLECT_DIGITS. When set and timeout fires, the menu will not be played again. Instead the caller is forwarded to the number configured here. |
| transferringPromptId | string If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is the prompt id to play before transferring the call to an extension or a user located by name. The prompt will be combined with the extension or name of the searched target. If dialling an extension, the extension is appended after the prompt; if dialling by name, the order of the combination is determined by transferringPromptPosition. |
| unavailablePromptId | string If the node type is EXTENSION_NODE, this is the prompt id to play if an invalid extension has been entered. |
| nameType | string For DIAL_BY_NAME nodes, the type of name against which the entered digits should be matched. Valid values are FIRSTNAME or LASTNAME. |
| dialByNameDigits | string If the node type is DIAL_BY_NAME, this is the amount of digits the caller will be expected to provide to perform a search for matching names. |
| transferringPromptPosition | string If the node type is DIAL_BY_NAME, this controls the position of the transferringPromptId in relation to the name prompt of the assumed target user. Valid values are BEFORE and AFTER. For example, if the positon is AFTER, a combination could sound "Emma Jones - one moment please". If there is no name prompt for the target user, only the transfer prompt is played. |
| selectionPromptId | string For DIAL_BY_NAME nodes where there is more than one possibility and there is a selectionKey defined, the purpose of this prompt is to inform the caller that the possible targets will be presented and which key he should press when the correct target is presented. |
| selectionKey | string If the node type is DIAL_BY_NAME, the entered digits could match more than one possible target (e.g. J O A can be either Joan or Joanna). If there are severalmatches and a selectionKey defined, the matches will be presented and the caller asked to press this key to confirm the correct target. If no key is defined, the first alphabetically matching person will be the assumed target. |
| numberOfDigitsToCollect | string If the node type is COLLECT_DIGITS, this is the number of digits to collect before forwarding the call.The key '#' is used to end the digit collection if this setting is not configured or its value is 0. |
| appendDigitsToDisplayName | boolean If the node type is COLLECT_DIGITS and this boolean is set, the collected digits are appended to the displayname before the call is forwarded. If the node metadata is configured then the collected digits are prefixed with node metadata and the result is appended to the displayname. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| metadata | string A string with the meta data of the auto attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string A telephone number to an operator that the user will be transferred to when pressing humanAssistanceKey. |
| humanAssistancePromptId | string The id of the prompt that is to be played before transferring to an operator. |
| groups | Array of strings If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is a list of group elements. List of User group names containing the users that can be reached with extension or name dialling. |
| functionNumbers | Array of strings If the node type is EXTENSION_NODE, this is a list of functionNumber elements. List of function numbers that can be reached with extension dialling. |
object (KeyAssignments) Contains key configuration for a menu node. |
Responses
Request samples
- Payload
{- "id": "12-2-1",
- "name": "new name",
- "description": "example description",
- "fnr": "+4612340"
}Response samples
- 200
- 400
{- "name": "new name",
- "fnr": "+4612340",
- "description": "example description",
- "id": "12-2-3"
}Create number Deprecated
Adding, removing or modifying a Auto Attendant number can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.number.inuse - not possible to create a new Auto Attendant with the number as it is already in use
fnr.number.out.of.range - not possible to create a new Auto Attendant with the number as it is outside of the number ranges of the organization
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.group.missing - the specified barring group is missing
xml.invalid - the XML does not validate against the schema
invalid.field - a field has an invalid value
missing.field - a mandatory field is missing
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| forwardNumberForCollectedDigits required | string If the node type is COLLECT_DIGITS, this is the phone number to which the call is forwarded after the digits are collected. The forwarded call carries the collected digits |
| id | string The id of the auto attendant number. For child nodes, the id of the child node. |
| name | string The name of the auto attendant number. For child nodes, it is the name of the child node. |
| description | string A textual description of the auto attendant number. For child nodes, the description of the child node. |
| fnr | string The auto attendant telephone number. |
| parentMenuNodeId | string The id of the parent node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node id to return to. The auto attendant call will continue executing at this node if the transfer fails. |
| keyNumber | string The dtmf key of the parent node the child node is attached to. |
| type | string Enum: "PLAY_MESSAGE" "MENU_NODE" "DIAL_NUMBER" "DIAL_USER" "DIAL_GROUP" "LEAVE_MESSAGE" "EXTENSION_NODE" "DIAL_BY_NAME" "BILINGUAL_NODE" "ASR" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "CALL_RECORDING_CONSENT_NODE" The type of the node. For the root node, this is always MENU_NODE. The type of the child node can be any of MENU_NODE, DIAL_NUMBER, EXTENSION_NODE, PLAY_MESSAGE, DIAL_BY_NAME. |
| phoneNumber | string If the node type is DIAL_NUMBER, this is the phone number to dial and transfer to. |
| promptId | string The prompt to play when entering this state. It's contents and purpose will vary depending on the node type, as follows: PLAY_MESSAGE - the message prompt to play. Typically containing information of some sort, e.g. opening hours. DIAL_NUMBER - the prompt to play before dialling a phone number. EXTENSION_NODE - the prompt is used to tell the user to enter the extension to which the call should be forwarded. DIAL_BY_NAME - the prompt is used to tell the caller to enter the first n digits of the name of the person to whom the call should be transferred. MENU_NODE - the prompt is used to present the available menu options. COLLECT_DIGITS - the prompt is used to tell the caller to enter the digits. When collected, the digits entered are forwarded along with the call. |
| numberOfTimesToPlay | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the number of times the prompt should be played when not receiving any input. |
| digitTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the time to wait before taking action when not receiving any input. |
| forwardNumberOnTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE and COLLECT_DIGITS. When set and timeout fires, the menu will not be played again. Instead the caller is forwarded to the number configured here. |
| transferringPromptId | string If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is the prompt id to play before transferring the call to an extension or a user located by name. The prompt will be combined with the extension or name of the searched target. If dialling an extension, the extension is appended after the prompt; if dialling by name, the order of the combination is determined by transferringPromptPosition. |
| unavailablePromptId | string If the node type is EXTENSION_NODE, this is the prompt id to play if an invalid extension has been entered. |
| nameType | string For DIAL_BY_NAME nodes, the type of name against which the entered digits should be matched. Valid values are FIRSTNAME or LASTNAME. |
| dialByNameDigits | string If the node type is DIAL_BY_NAME, this is the amount of digits the caller will be expected to provide to perform a search for matching names. |
| transferringPromptPosition | string If the node type is DIAL_BY_NAME, this controls the position of the transferringPromptId in relation to the name prompt of the assumed target user. Valid values are BEFORE and AFTER. For example, if the positon is AFTER, a combination could sound "Emma Jones - one moment please". If there is no name prompt for the target user, only the transfer prompt is played. |
| selectionPromptId | string For DIAL_BY_NAME nodes where there is more than one possibility and there is a selectionKey defined, the purpose of this prompt is to inform the caller that the possible targets will be presented and which key he should press when the correct target is presented. |
| selectionKey | string If the node type is DIAL_BY_NAME, the entered digits could match more than one possible target (e.g. J O A can be either Joan or Joanna). If there are severalmatches and a selectionKey defined, the matches will be presented and the caller asked to press this key to confirm the correct target. If no key is defined, the first alphabetically matching person will be the assumed target. |
| numberOfDigitsToCollect | string If the node type is COLLECT_DIGITS, this is the number of digits to collect before forwarding the call.The key '#' is used to end the digit collection if this setting is not configured or its value is 0. |
| appendDigitsToDisplayName | boolean If the node type is COLLECT_DIGITS and this boolean is set, the collected digits are appended to the displayname before the call is forwarded. If the node metadata is configured then the collected digits are prefixed with node metadata and the result is appended to the displayname. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| metadata | string A string with the meta data of the auto attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string A telephone number to an operator that the user will be transferred to when pressing humanAssistanceKey. |
| humanAssistancePromptId | string The id of the prompt that is to be played before transferring to an operator. |
| groups | Array of strings If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is a list of group elements. List of User group names containing the users that can be reached with extension or name dialling. |
| functionNumbers | Array of strings If the node type is EXTENSION_NODE, this is a list of functionNumber elements. List of function numbers that can be reached with extension dialling. |
object (KeyAssignments) Contains key configuration for a menu node. |
Responses
Request samples
- Payload
{- "name": "name",
- "description": "example description",
- "fnr": "+4612340"
}Response samples
- 200
- 400
{- "name": "name",
- "fnr": "+4612340",
- "description": "example description",
- "id": "12-2-3"
}Delete number Deprecated
Removes an Auto Attendant function number. See API to create AutoAttendant Number for possible error codes.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "name": "example",
- "fnr": "+46123404",
- "description": "example description",
- "id": "12-2-3"
}Get Auto Attendant number
Gets the details of an Auto Attendant number and its nodes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The Auto Attendant function number |
Responses
Response samples
- 200
- 400
AA_TREE_MENU
{- "autoAttendantNumber": {
- "fnr": "+123400",
- "name": "AutoAttendantNumber",
- "description": "Example AA",
- "metadata": "Test Metadata",
- "overrideMetadata": true,
- "billingId": "+4611110000",
- "barringGroups": [
- "BarGroup"
], - "topMenuDigit": "*",
- "previousMenuDigit": "#",
- "humanAssistanceKey": "9",
- "humanAssistanceNumber": "+4622223333",
- "humanAssistancePromptId": "system_welcome"
}, - "aaRootNode": {
- "id": "11-10-1",
- "keyNumber": "0",
- "type": "MENU_NODE",
- "nodeMetadata": "Dial Number Menu",
- "isEditable": true,
- "isDeletable": false,
- "menuNode": {
- "promptId": "system_welcome",
- "numberOfTimesToPlay": "4",
- "forwardNumberOnTimeout": "+4633334444",
- "digitTimeout": "5",
- "keyAssignments": {
- "keys": [
- "0-10-2",
- "2-10-2",
- "6-10-2",
- "7-10-2",
- "9-10-2",
- "10-10-2",
- "11-10-2",
- "12-10-2",
- "Unassigned",
- "Unassigned"
]
}
}, - "aaNodes": [
- {
- "id": "11-10-9",
- "name": "Speech Auto Attendant",
- "description": "Invoke speech recognition via external service",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "1",
- "type": "SPEECH_AUTO_ATTENDANT",
- "isEditable": true,
- "isDeletable": true,
- "saaNode": {
- "saaProfile": "orgSaaProfile1"
}
}, - {
- "id": "11-10-11",
- "name": "API Integration",
- "description": "Invoke external API ",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "2",
- "type": "API_INTEGRATION_NODE",
- "isEditable": true,
- "isDeletable": true,
- "apiIntegrationNode": {
- "promptId": "system_welcome",
- "apiTarget": {
- "isPublic": false,
- "apiSecurityScheme": "BASIC",
- "clientId": "org.com",
- "secret": "adhj234kahsdkjh56627"
}, - "forwardNumberOnError": "+46923492742"
}
}, - {
- "id": "11-10-10",
- "name": "Collect Digits",
- "description": "Collect ticket number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "3",
- "type": "COLLECT_DIGITS",
- "isEditable": true,
- "isDeletable": true,
- "collectDigitsNode": {
- "promptId": "system_busy_greeting",
- "numberOfTimesToPlay": "5",
- "digitTimeout": "5",
- "forwardNumberOnTimeout": "+46923492742",
- "numberOfDigitsToCollect": "5",
- "appendDigitsToDisplayName": true,
- "actionAfterDigitsCollection": "FORWARD_TO_NUMBER",
- "forwardNumberForCollectedDigits": "+46923492742",
- "apiTarget": { }
}
}, - {
- "id": "11-10-7",
- "name": "Dial by name",
- "description": "Dial users by initials",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "4",
- "type": "DIAL_BY_NAME",
- "transferFallbackNodeId": "this",
- "isEditable": true,
- "isDeletable": true,
- "dialByNameNode": {
- "transferringPromptId": "system_meeting_greeting",
- "promptId": "system_welcome",
- "groups": [
- "user_grp"
], - "unavailablePromptId": "system_busy_greeting",
- "nameType": "FIRSTNAME",
- "dialByNameDigits": "2",
- "transferringPromptPosition": "AFTER",
- "selectionPromptId": "system_silence",
- "selectionKey": "2"
}
}, - {
- "id": "11-10-2",
- "name": "Dial a number",
- "description": "Dials configured number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "5",
- "type": "DIAL_NUMBER",
- "isEditable": true,
- "isDeletable": true,
- "dialNumberNode": {
- "promptId": "system_busy_greeting",
- "phoneNumber": "+46923492742"
}
}, - {
- "id": "11-10-6",
- "name": "Extension",
- "description": "Dial users by extension",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "6",
- "type": "EXTENSION_NODE",
- "transferFallbackNodeId": "this",
- "isEditable": true,
- "isDeletable": true,
- "extensionNode": {
- "promptId": "system_lunch_greeting",
- "forwardNumberOnTimeout": "+46923492742",
- "digitTimeout": "5",
- "groups": [
- "user_grp"
], - "functionNumbers": [
- "+46899995010"
], - "transferringPromptId": "system_meeting_greeting",
- "unavailablePromptId": "system_lunch_greeting"
}
}, - {
- "id": "11-10-0",
- "name": "Play Message",
- "description": "Play out of office message",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "7",
- "type": "PLAY_MESSAGE",
- "isEditable": true,
- "isDeletable": true,
- "playMessageNode": {
- "promptId": "system_busy_greeting"
}
}, - {
- "id": "11-10-10",
- "name": "Collect Digits",
- "description": "Collect ticket number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "8",
- "type": "COLLECT_DIGITS",
- "isEditable": true,
- "isDeletable": true,
- "collectDigitsNode": {
- "promptId": "system_busy_greeting",
- "numberOfTimesToPlay": "5",
- "digitTimeout": "5",
- "forwardNumberOnTimeout": "+46923492742",
- "numberOfDigitsToCollect": "5",
- "appendDigitsToDisplayName": true,
- "actionAfterDigitsCollection": "INVOKE_API",
- "apiTarget": {
- "isPublic": false,
- "apiSecurityScheme": "BASIC",
- "clientId": "org.com",
- "secret": "adhj234kahsdkjh56627"
}
}
}
]
}
}Update Auto Attendant number
Updates the Auto Attendant number. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: application/jsonrequired
| fnr | string The Auto Attendant telephone number. |
| name | string The name of the Auto Attendant number. |
| description | string The description of the Auto Attendant number. |
| metadata | string A string with the meta data of the Auto Attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string The telephone number of the operator to whom the user will be transferred when pressing the humanAssistanceKey. |
| humanAssistancePromptId | string The ID of the prompt that is to be played before transferring to an operator. |
Responses
Request samples
- Payload
{- "fnr": "+4612340",
- "name": "new name",
- "description": "example description"
}Response samples
- 200
- 400
{- "name": "new name",
- "fnr": "+4612340",
- "description": "example description"
}Create Auto Attendant number
Creates an Auto Attendant number. This API can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.number.inuse - not possible to create a new Auto Attendant with the number as it is already in use
fnr.number.out.of.range - not possible to create a new Auto Attendant with the number as it is outside of the number ranges of the organization
fnr.invalid.billingid - the specified billing ID is not within a configured billing range
fnr.group.missing - the specified barring group is missing
invalid.field - a field has an invalid value
missing.field - a mandatory field is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The Auto Attendant function number |
Request Body schema: application/jsonrequired
| fnr | string The Auto Attendant telephone number. |
| name | string The name of the Auto Attendant number. |
| description | string The description of the Auto Attendant number. |
| metadata | string A string with the meta data of the Auto Attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string The telephone number of the operator to whom the user will be transferred when pressing the humanAssistanceKey. |
| humanAssistancePromptId | string The ID of the prompt that is to be played before transferring to an operator. |
Responses
Request samples
- Payload
{- "fnr": "+4612340",
- "name": "Sample Auto Attendant",
- "description": "example description",
- "metadata": "Test AA",
- "overrideMetadata": false,
- "billingId": "billingId",
- "topMenuDigit": "1",
- "previousMenuDigit": "2",
- "humanAssistanceKey": "0",
- "humanAssistanceNumber": "+46736484567",
- "humanAssistancePromptId": "system_welcome"
}Response samples
- 200
- 400
{- "name": "name",
- "fnr": "+4612340",
- "description": "example description"
}Delete number
Deletes Auto Attendant function number and its nodes. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The Auto Attendant function number |
Responses
Response samples
- 200
- 400
{- "name": "example",
- "fnr": "+4612340",
- "description": ""
}Get tree node Deprecated
Fetch information about a node in an Auto Attendant tree.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The id of the node in question |
Responses
Response samples
- 200
- 400
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "auto_attendant_dial_a_number",
- "description": "Main Attendant",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "3",
- "type": "DIAL_NUMBER",
- "phoneNumber": "0923492742",
- "promptId": "system_busy_greeting"
}Update tree node Deprecated
Update a node in an Auto Attendant tree. See API to create AutoAttendant Number for possible error codes.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The id of the node in question |
Request Body schema: required
| forwardNumberForCollectedDigits required | string If the node type is COLLECT_DIGITS, this is the phone number to which the call is forwarded after the digits are collected. The forwarded call carries the collected digits |
| id | string The id of the auto attendant number. For child nodes, the id of the child node. |
| name | string The name of the auto attendant number. For child nodes, it is the name of the child node. |
| description | string A textual description of the auto attendant number. For child nodes, the description of the child node. |
| fnr | string The auto attendant telephone number. |
| parentMenuNodeId | string The id of the parent node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node id to return to. The auto attendant call will continue executing at this node if the transfer fails. |
| keyNumber | string The dtmf key of the parent node the child node is attached to. |
| type | string Enum: "PLAY_MESSAGE" "MENU_NODE" "DIAL_NUMBER" "DIAL_USER" "DIAL_GROUP" "LEAVE_MESSAGE" "EXTENSION_NODE" "DIAL_BY_NAME" "BILINGUAL_NODE" "ASR" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "CALL_RECORDING_CONSENT_NODE" The type of the node. For the root node, this is always MENU_NODE. The type of the child node can be any of MENU_NODE, DIAL_NUMBER, EXTENSION_NODE, PLAY_MESSAGE, DIAL_BY_NAME. |
| phoneNumber | string If the node type is DIAL_NUMBER, this is the phone number to dial and transfer to. |
| promptId | string The prompt to play when entering this state. It's contents and purpose will vary depending on the node type, as follows: PLAY_MESSAGE - the message prompt to play. Typically containing information of some sort, e.g. opening hours. DIAL_NUMBER - the prompt to play before dialling a phone number. EXTENSION_NODE - the prompt is used to tell the user to enter the extension to which the call should be forwarded. DIAL_BY_NAME - the prompt is used to tell the caller to enter the first n digits of the name of the person to whom the call should be transferred. MENU_NODE - the prompt is used to present the available menu options. COLLECT_DIGITS - the prompt is used to tell the caller to enter the digits. When collected, the digits entered are forwarded along with the call. |
| numberOfTimesToPlay | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the number of times the prompt should be played when not receiving any input. |
| digitTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE, DIAL_BY_NAME and COLLECT_DIGITS. Set this to the time to wait before taking action when not receiving any input. |
| forwardNumberOnTimeout | string Applicable to node types MENU_NODE, EXTENSION_NODE and COLLECT_DIGITS. When set and timeout fires, the menu will not be played again. Instead the caller is forwarded to the number configured here. |
| transferringPromptId | string If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is the prompt id to play before transferring the call to an extension or a user located by name. The prompt will be combined with the extension or name of the searched target. If dialling an extension, the extension is appended after the prompt; if dialling by name, the order of the combination is determined by transferringPromptPosition. |
| unavailablePromptId | string If the node type is EXTENSION_NODE, this is the prompt id to play if an invalid extension has been entered. |
| nameType | string For DIAL_BY_NAME nodes, the type of name against which the entered digits should be matched. Valid values are FIRSTNAME or LASTNAME. |
| dialByNameDigits | string If the node type is DIAL_BY_NAME, this is the amount of digits the caller will be expected to provide to perform a search for matching names. |
| transferringPromptPosition | string If the node type is DIAL_BY_NAME, this controls the position of the transferringPromptId in relation to the name prompt of the assumed target user. Valid values are BEFORE and AFTER. For example, if the positon is AFTER, a combination could sound "Emma Jones - one moment please". If there is no name prompt for the target user, only the transfer prompt is played. |
| selectionPromptId | string For DIAL_BY_NAME nodes where there is more than one possibility and there is a selectionKey defined, the purpose of this prompt is to inform the caller that the possible targets will be presented and which key he should press when the correct target is presented. |
| selectionKey | string If the node type is DIAL_BY_NAME, the entered digits could match more than one possible target (e.g. J O A can be either Joan or Joanna). If there are severalmatches and a selectionKey defined, the matches will be presented and the caller asked to press this key to confirm the correct target. If no key is defined, the first alphabetically matching person will be the assumed target. |
| numberOfDigitsToCollect | string If the node type is COLLECT_DIGITS, this is the number of digits to collect before forwarding the call.The key '#' is used to end the digit collection if this setting is not configured or its value is 0. |
| appendDigitsToDisplayName | boolean If the node type is COLLECT_DIGITS and this boolean is set, the collected digits are appended to the displayname before the call is forwarded. If the node metadata is configured then the collected digits are prefixed with node metadata and the result is appended to the displayname. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| metadata | string A string with the meta data of the auto attendant number. |
| overrideMetadata | boolean Boolean whether to override metadata. Can be true or false. |
| topMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the root node. |
| previousMenuDigit | string A DTMF digit (0-9, * or #) that will move back in menu to the previous node. |
| humanAssistanceKey | string A DTMF key (0-9, * or #) that will be used in all nodes to connect to humanAssistanceNumber. |
| humanAssistanceNumber | string A telephone number to an operator that the user will be transferred to when pressing humanAssistanceKey. |
| humanAssistancePromptId | string The id of the prompt that is to be played before transferring to an operator. |
| groups | Array of strings If the node type is EXTENSION_NODE or DIAL_BY_NAME, this is a list of group elements. List of User group names containing the users that can be reached with extension or name dialling. |
| functionNumbers | Array of strings If the node type is EXTENSION_NODE, this is a list of functionNumber elements. List of function numbers that can be reached with extension dialling. |
Responses
Request samples
- Payload
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "auto_attendant_dial_a_number",
- "description": "Main Attendant",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "3",
- "type": "DIAL_NUMBER",
- "phoneNumber": "0923492742",
- "promptId": "system_busy_greeting"
}Response samples
- 200
- 400
{- "id": "11-10-2"
}Delete tree node Deprecated
Delete a node in an Auto Attendant tree. See API to create AutoAttendant Number for possible error codes.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The id of the node in question |
Responses
Response samples
- 200
- 400
{- "id": "11-10-2"
}Get tree node
Fetches information about a node in an Auto Attendant tree.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The ID of the node in question |
Responses
Response samples
- 200
- 400
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "Dial a number",
- "description": "Dials configured number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "5",
- "type": "DIAL_NUMBER",
- "isEditable": true,
- "isDeletable": true,
- "dialNumberNode": {
- "promptId": "system_busy_greeting",
- "phoneNumber": "+46923492742"
}
}Update tree node
Updates a node in an Auto Attendant tree. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The ID of the node in question |
Request Body schema: application/jsonrequired
| type required | string Enum: "MENU_NODE" "PLAY_MESSAGE" "DIAL_NUMBER" "DIAL_USER" "EXTENSION_NODE" "DIAL_BY_NAME" "COLLECT_DIGITS" "API_INTEGRATION_NODE" "SPEECH_AUTO_ATTENDANT" "CALL_RECORDING_CONSENT" The type of the node. |
| id | string The ID of the node. When creating a node, this attribute is not applicable. |
| name | string The name of the node. |
| description | string The description of the node. |
| parentMenuNodeId | string The ID of the parent node. When creating a root node, this attribute is not applicable. |
| keyNumber | string The DTMF key of the parent node the child node is attached to. When creating a root node, this attribute is not applicable. |
| nodeMetadata | string A string with the meta data of the node. |
| transferFallbackNodeId | string To enable supervised transfer this should be set to the node ID to return to. The Auto Attendant call will continue executing at this node if the transfer fails. This field is not applicable when the node type is API_INTEGRATION_NODE or COLLECT_DIGITS with actionAfterDigitsCollection as INVOKE_API. |
| isEditable | boolean This is set to true if the node is editable. |
| isDeletable | boolean This is set to true if the node is deletable. |
object (MenuNodeV2DTO) The details of menu node if the node is of type MENU_NODE. | |
object (DialNumberNodeDTO) The details of dial number node if the node is of type DIAL_NUMBER. | |
object (PlayMessageDTO) The details of play message node if the node is of type PLAY_MESSAGE. | |
object (CollectDigitsDTO) The details of collect digits node if the node is of type COLLECT_DIGITS. | |
object (ExtensionNodeDTO) The details of extension node if the node is of type EXTENSION_NODE. | |
object (DialByNameNodeDTO) The details of dial by name node if the node is of type DIAL_BY_NAME. | |
object (APIIntegrationNodeDTO) The details of API integration node if the node is of type API_INTEGRATION_NODE. | |
object (SAANodeDTO) The details of Speech Auto Attendant node if the node is of type SPEECH_AUTO_ATTENDANT. | |
object (CallRecordingConsentNodeDTO) The details of Call recording consent node if the node is of type CALL_RECORDING_CONSENT. |
Responses
Request samples
- Payload
DIAL_A_NUMBER
{- "id": "11-10-2",
- "name": "Dial a number",
- "description": "Dials configured number",
- "parentMenuNodeId": "11-10-1",
- "keyNumber": "5",
- "type": "DIAL_NUMBER",
- "isEditable": true,
- "isDeletable": true,
- "dialNumberNode": {
- "promptId": "system_busy_greeting",
- "phoneNumber": "+46923492742"
}
}Response samples
- 200
- 400
{- "id": "11-10-2"
}Delete tree node
Deletes a node in an Auto Attendant tree. See API to create Auto Attendant number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| id required | string The ID of the node in question |
Responses
Response samples
- 200
- 400
{- "id": "11-10-2"
}List numbers Deprecated
Fetches all Auto Attendant numbers in an organization.
NOTE: This method is DEPRECATED since 5.5 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
Responses
Response samples
- 200
- 400
{- "autoAttendant": [
- {
- "name": "auto_attendant",
- "fnr": "+123400",
- "description": "Main Office attendant",
- "id": "1-10-3"
}
]
}List Auto Attendant numbers
Fetches all Auto Attendant numbers in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
Responses
Response samples
- 200
- 400
{- "autoAttendantNumbers": [
- {
- "name": "auto_attendant",
- "fnr": "+123400",
- "description": ""
}
]
}The Conference Number API is used to manage conference numbers.
Use the Conference Number API to:
- Create conference number
- Create conference number with barring groups
- Get conference number
- Get conference number id
- Update conference number
- Delete conference number
Get conference number
Retrieve conference number
Authorizations:
path Parameters
| domain required | string The domain of the organization the conference number belongs to |
| number required | string The conference number |
Responses
Response samples
- 200
Conference number
{- "number": "+46899995060"
}Update conference number
Update can be used to either add or remove barring group(s).
See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the conference number belongs to |
| number required | string The conference number |
Request Body schema: */*required
| number | string Conference number. |
| barringGroups | Array of strings The barring groups that should apply for this conference number. |
Responses
Request samples
- Payload
{ "number": "+46899995060" }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create conference number
Adding a voicemail, group inbox retrieval or conference number can cause the following error:
fnr.number.inuse - not possible to create a new voicemail, group inbox retrieval or conference with the number as it is already in use
fnr.number.out.of.range - not possible to create a new voicemail, group inbox retrieval or conference with the number as it is outside of the number ranges of the organization
fnr.group.missing - the specified barring group is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the conference number belongs to |
| number required | string The conference number |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create conference number with barring group
See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the conference number belongs to |
| number required | string The conference number |
Request Body schema: */*required
| number | string Conference number. |
| barringGroups | Array of strings The barring groups that should apply for this conference number. |
Responses
Request samples
- Payload
{ "number": "+46899995065", "barringGroups": [ "BarringGroupConference" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Distribution Group Admin API is used to manage various features that apply for function numbers of type ACD, ACD Light and Attendant.
Use the Distribution Group Admin API to:
- Get the distribution list for a distribution group in an organization
- Update the distribution list for a distribution group in an organization
- Get an overview of the distribution list priorities in an organization
List distribution group priorities
Retrieves a list of prioritized distribution group function numbers (ACD, ACD Light or Attendant function numbers).
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch prioritized function numbers |
Responses
Response samples
- 200
- 400
[- {
- "id": 0,
- "name": "string",
- "phoneNumber": "string",
- "featureCodeIdentifier": "string",
- "metadata": "string",
- "overrideMetadata": true,
- "priority": 0,
- "type": "string"
}
]Get distribution list
Fetches a distribution list.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "distribution": [
- {
- "user": "string",
- "domain": "string",
- "priority": 0
}
]
}Update distribution list
Modifying the distribution list can cause the following errors:
fnr.invalid.priority - When distributionType is set to SKILLS the priority value is required to be in range 1-5 ("skill level"). When distributionType is set to PRIORITY duplicate priority values are not allowed.fnr.invalid.user - the user does not exist in the organization or a federated organization, or is not a member of a valid group
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: application/json
Array of objects (distribution) You can have multiple distribution sections, each corresponding to a prioritized distribution to an agent. Agents not in the list will be assigned a default priority depending on distributionType of the ACD or attendant number. If distributionType is set to SKILLS the default priority is 3. If it is PRIORITY the default priority will be lower than all other users in the list (highest value + 1, sice low numbers means higher priority) |
Responses
Request samples
- Payload
{- "distribution": [
- {
- "user": "string",
- "domain": "string",
- "priority": 0
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get distribution list Deprecated
Fetches a distribution list.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "distribution": [
- {
- "user": "string",
- "domain": "string",
- "priority": 0
}
]
}Update distribution list Deprecated
Modifying the distribution list can cause the following errors:
fnr.invalid.priority - When distributionType is set to SKILLS the priority value is required to be in range 1-5 ("skill level"). When distributionType is set to PRIORITY duplicate priority values are not allowed.fnr.invalid.user - the user does not exist in the organization or a federated organization, or is not a member of a valid group
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema:
Array of objects (distribution) You can have multiple distribution sections, each corresponding to a prioritized distribution to an agent. Agents not in the list will be assigned a default priority depending on distributionType of the ACD or attendant number. If distributionType is set to SKILLS the default priority is 3. If it is PRIORITY the default priority will be lower than all other users in the list (highest value + 1, sice low numbers means higher priority) |
Responses
Request samples
- Payload
{- "distribution": [
- {
- "user": "string",
- "domain": "string",
- "priority": 0
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The External System API is used to manage external system numbers.
Use the External System API to:
- Create External System numbers
- Get External System numbers
- Update External System numbers
- Delete External System numbers
Get External System number
Get an existing External System number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "id": 23,
- "fnr": "+46899995190",
- "name": "External System 1",
- "metadata": "External System",
- "overrideMetadata": false,
- "groups": [ ],
- "billingId": "+46899995190",
- "showNumberForRoutingRules": true,
- "description": "External system for call handling",
- "destinationTags": [
- "Calltag"
], - "searchableBySAA": false
}Update External System number
Update an existing External System number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: required
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| showNumberForRoutingRules | boolean Whether the function numbers should be available as destination for call routing rules, true or false. |
| description | string Description of the External system. |
| destinationTags | Array of strings The destination tags that should be added to this function number. |
| searchableBySAA | boolean Whether or not this function number can be searched by Speech Auto Attendant services, true or false. |
Array of objects (LocalizedStringValue) None or several localizedValue elements that holds names by which this group number will be recognized by Speech Auto Attendant services. |
Responses
Request samples
- Payload
{- "id": 23,
- "fnr": "+46899995190",
- "name": "External System 1",
- "metadata": "External System",
- "overrideMetadata": false,
- "groups": [ ],
- "billingId": "+46899995190",
- "showNumberForRoutingRules": true,
- "description": "External system for call handling",
- "destinationTags": [
- "Calltag"
], - "searchableBySAA": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create External System number
Create an External System number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: required
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| showNumberForRoutingRules | boolean Whether the function numbers should be available as destination for call routing rules, true or false. |
| description | string Description of the External system. |
| destinationTags | Array of strings The destination tags that should be added to this function number. |
| searchableBySAA | boolean Whether or not this function number can be searched by Speech Auto Attendant services, true or false. |
Array of objects (LocalizedStringValue) None or several localizedValue elements that holds names by which this group number will be recognized by Speech Auto Attendant services. |
Responses
Request samples
- Payload
{- "fnr": "+46899995190",
- "name": "External System 1",
- "metadata": "External System",
- "overrideMetadata": false,
- "groups": [ ],
- "billingId": "+46899995190",
- "showNumberForRoutingRules": true,
- "description": "External system for call handling",
- "destinationTags": [
- "Calltag"
], - "searchableBySAA": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Fax API is used to manage fax numbers.
Use the Fax API to:
- Create Fax numbers
- Get Fax numbers
- Update Fax numbers
- Delete Fax numbers
Get Fax number
Retrieve the FAX number details identified by the number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "number": "+46899995170",
- "registeringPassword": "hash:2907d03e5b286625a71bc71ce0e0f708",
- "name": "HeadOffice FAX",
- "billingId": "+46899995170",
- "barringGroups": [
- "Internal"
], - "registeringUserName": "fax.46899995170@foo.com"
}Update Fax number
Update an existing Fax number. See API to create Fax Number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: */*required
| name required | string The name of the fax number. |
| registeringPassword required | string The fax password. Format is hash:{value}. |
| number | string The phone number of the fax number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| registeringUserName | string The fax user name. The string is in the format fax.{number}@{domain} |
Responses
Request samples
- Payload
{ "number": "+46899995170", "registeringPassword": "hash:2907d03e5b286625a71bc71ce0e0f708", "name": "HeadOffice FAX", "billingId": "+46899995170", "barringGroups": [ "Internal" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Fax number
Create a Fax number. Adding, removing or modifying a fax number can cause the following errors:
fnr.number.inuse - not possible to create a new fax with the number as it is already in use
fnr.number.out.of.range - not possible to create a new fax with the number as it is outside of the number ranges of the organization
fnr.fax.invalidType - If the fields for both the registering type and the FXS type are set
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.group.missing - the specified barring group is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: */*required
| name required | string The name of the fax number. |
| registeringPassword required | string The fax password. Format is hash:{value}. |
| number | string The phone number of the fax number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| registeringUserName | string The fax user name. The string is in the format fax.{number}@{domain} |
Responses
Request samples
- Payload
{ "number": "+46899995170", "registeringPassword": "hash:2907d03e5b286625a71bc71ce0e0f708", "name": "HeadOffice FAX" }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Function Number API is used to manage function numbers in general.
Use the Function Number API to:
- Get all function numbers or for specified type
- Update the phone number for a function number
List function numbers
Retrieve all function numbers
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| type | string Enum: "ACD" "ACD_LIGHT" "ATTENDANT" "CONFERENCE" "IVR_MENU" "VOICEMAIL_RETRIEVAL" "FAX_NUMBER" "RULE_BASED" "HUNT_GROUP" "SHARED_LINE" "EXTERNAL_SYSTEM" "GROUP_INBOX" "GROUP_INBOX_RETRIEVAL" "AUTO_ATTENDANT" The function number type |
Responses
Response samples
- 200
{- "functionNumber": [
- {
- "id": 10,
- "name": "Acd Group 1",
- "number": "+46899995006",
- "type": "ACD"
}, - {
- "id": 11,
- "name": "AcdLight",
- "number": "+46899995007",
- "type": "ACD_LIGHT"
}, - {
- "id": 15,
- "name": "Attendant",
- "number": "+46899995001",
- "type": "ATTENDANT",
- "groupAdminProfile": "AttendantResponsible"
}
]
}Update phone number
Change the phone number associated with a function number.
Response error codes:
fnr.number.inuse - the new phone number is already in use
fnr.number.out.of.range - the number is not in one of the organization's number ranges
fnr.invalid.type - the phone number can not be changed for this type of function number
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| oldnumber required | string The phone number currently assigned to the function number |
| newnumber required | string The new phone number that should be associated with the function number |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Group Inbox API is used to manage group inboxes and their number.
Use the Group Inbox API to:
- Get a group inbox number
- Create a group inbox number
- Update a group inbox number
- Delete a group inbox number
- Get a group inbox retrieval number
- Create a group inbox retrieval number
- Create a group inbox retrieval number with barring groups
- Update a group inbox retrieval number
- Delete a group inbox retrieval number
Get Group Inbox number Deprecated
Use this method to retrieve an existing Group Inbox number.
NOTE: This method is DEPRECATED since 5.3 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 27,
- "fnr": "+46765964122",
- "name": "Group Inbox for Test",
- "overrideMetadata": true,
- "excludeFromSearch": false,
- "groupAdminProfile": [
- "main_grp_admin"
], - "groups": [
- "barring_grp1",
- "barring_grp2",
- "test_grp3",
- "test_grp2",
- "test_grp1"
], - "groupInboxPin": "4356",
- "groupInboxPromptId": "Welcome",
- "allowAnonymousCallers": false,
- "smsGroups": [
- "test_grp1",
- "test_grp3"
], - "emailGroups": [
- "test_grp1",
- "test_grp2",
- "test_grp3"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "Group Inbox Number",
- "language": "en"
}
]
}Update Group Inbox number Deprecated
Updates an existing Group Inbox number. See the API for creating Group Inbox for possible error codes.
NOTE: This method is DEPRECATED since 5.3 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| excludeFromSearch required | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| groupInboxPin required | string Code that identifies this group inbox when calling a group inbox retrieval number. |
| groupInboxPromptId required | string The voice prompt that is played to caller before voicemail is recorded. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| groups | Array of strings List of User Groups that can answer the calls or barring groups that should apply for this number. |
| allowAnonymousCallers | boolean Allow a caller that is calling anonymously to retrieve messages of this group inbox after being prompted for personal number and pin. |
| smsGroups | Array of strings One or many user groups whose users will receive SMS notifications when new messages are deposited in the group inbox. |
| emailGroups | Array of strings One or many user groups whose users will receive E-mail notifictions when new messages are deposited in the group inbox. Note that the message will not be included as an attachment to the E-mail. |
| searchableBySAA | boolean Whether the group inbox number is searchable by Speech Auto Attendant or not. Note that the number must also be enabled by an SAA profile to be reached |
Array of objects (LocalizedStringValue) List of Speech Auto Attendant aliases. |
Responses
Request samples
- Payload
{- "id": 27,
- "fnr": "+46765964122",
- "name": "Group Inbox for Test",
- "overrideMetadata": true,
- "excludeFromSearch": false,
- "groupAdminProfile": [
- "main_grp_admin"
], - "groups": [
- "barring_grp1",
- "barring_grp2",
- "test_grp2",
- "test_grp1"
], - "groupInboxPin": "4356",
- "groupInboxPromptId": "Welcome",
- "allowAnonymousCallers": false,
- "smsGroups": [
- "test_grp1",
- "test_grp3"
], - "emailGroups": [
- "test_grp1",
- "test_grp2"
], - "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "Group Inbox Number",
- "language": "en"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Group Inbox number Deprecated
Creates a Group Inbox number. Adding, removing or modifying a group inbox can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.group.missing - the specified group is missing
organization.invalid.asr.language - the language id stated in an saaAlias instance is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - the names stated in an saaAlias instance contain unsupported characters for the language specified
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
NOTE: This method is DEPRECATED since 5.3 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| excludeFromSearch required | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| groupInboxPin required | string Code that identifies this group inbox when calling a group inbox retrieval number. |
| groupInboxPromptId required | string The voice prompt that is played to caller before voicemail is recorded. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| groups | Array of strings List of User Groups that can answer the calls or barring groups that should apply for this number. |
| allowAnonymousCallers | boolean Allow a caller that is calling anonymously to retrieve messages of this group inbox after being prompted for personal number and pin. |
| smsGroups | Array of strings One or many user groups whose users will receive SMS notifications when new messages are deposited in the group inbox. |
| emailGroups | Array of strings One or many user groups whose users will receive E-mail notifictions when new messages are deposited in the group inbox. Note that the message will not be included as an attachment to the E-mail. |
| searchableBySAA | boolean Whether the group inbox number is searchable by Speech Auto Attendant or not. Note that the number must also be enabled by an SAA profile to be reached |
Array of objects (LocalizedStringValue) List of Speech Auto Attendant aliases. |
Responses
Request samples
- Payload
{ "fnr": "+46765964122", "name": "Group Inbox for Test", "overrideMetadata": true, "excludeFromSearch": false, "groupAdminProfile": [ "main_grp_admin" ], "groups": [ "barring_grp1", "barring_grp2", "test_grp3", "test_grp2", "test_grp1" ], "groupInboxPin": "4356", "groupInboxPromptId": "Welcome", "allowAnonymousCallers": false, "smsGroups": [ "test_grp1", "test_grp3" ], "emailGroups": [ "test_grp1", "test_grp2", "test_grp3" ], "searchableBySAA": true, "saaAliases": [ { "value": "Group Inbox Number", "language": "en" } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get Group Inbox retrieval number
Use this method to get an existing Group Inbox retrieval number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "number": "+46765959191",
- "barringGroups": [
- "test_grp1",
- "test_grp2"
]
}Updates a Group Inbox retrieval number
See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| number | string Voicemail Number is used to access the voicemail service from a phone |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Responses
Request samples
- Payload
{ "number": "+46765959000", "barringGroups": [ "barring2", "barring3" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Group Inbox retrieval number
Creates a Group Inbox retrieval number. See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Group Inbox retrieval number with barring groups
See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| number | string Voicemail Number is used to access the voicemail service from a phone |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Responses
Request samples
- Payload
{ "number": "+46765959000", "barringGroups": [ "barring1", "barring2" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get Group Inbox number
Use this method to retrieve an existing Group Inbox number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 27,
- "fnr": "+46765964122",
- "name": "Group Inbox for Test",
- "overrideMetadata": true,
- "excludeFromSearch": false,
- "groupAdminProfile": [
- "main_grp_admin"
], - "groups": [
- "barring_grp1",
- "barring_grp2",
- "test_grp3",
- "test_grp2",
- "test_grp1"
], - "groupInboxPin": "4356",
- "groupInboxPromptId": "Welcome",
- "allowAnonymousCallers": false,
- "smsGroups": [
- "test_grp1",
- "test_grp3"
], - "emailGroups": [
- "test_grp1",
- "test_grp2",
- "test_grp3"
], - "retentionTime": 12,
- "maxInboxSize": 55,
- "fileAttached": true,
- "playOldestMessageFirst": true,
- "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "Group Inbox Number",
- "language": "en"
}
]
}Update Group Inbox number
Updates an existing Group Inbox number. See the API for creating Group Inbox for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: application/jsonrequired
| excludeFromSearch required | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| groupInboxPin required | string Code that identifies this group inbox when calling a group inbox retrieval number. |
| groupInboxPromptId required | string The voice prompt that is played to caller before voicemail is recorded. |
| maxInboxSize required | integer <int32> [ 1 .. 250 ] The max size of all messages stored in the inbox in megabytes |
| name required | string The name of the function number. |
| retentionTime required | integer <int32> [ 1 .. 40 ] The number of days that old messages should be saved before they are automatically deleted |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| groups | Array of strings List of User Groups that can answer the calls or barring groups that should apply for this number. |
| allowAnonymousCallers | boolean Allow a caller that is calling anonymously to retrieve messages of this group inbox after being prompted for personal number and pin. |
| smsGroups | Array of strings One or many user groups whose users will receive SMS notifications when new messages are deposited in the group inbox. |
| emailGroups | Array of strings One or many user groups whose users will receive E-mail notifictions when new messages are deposited in the group inbox. Note that the message will not be included as an attachment to the E-mail. |
| searchableBySAA | boolean Whether the group inbox number is searchable by Speech Auto Attendant or not. Note that the number must also be enabled by an SAA profile to be reached |
Array of objects List of Speech Auto Attendant aliases. | |
| fileAttached | boolean Controls if message voice files should be attached to email notifications |
| playOldestMessageFirst | boolean Controls if the messages should be played from oldest to newest when listening to the inbox |
Responses
Request samples
- Payload
{- "id": 27,
- "fnr": "+46765964122",
- "name": "Group Inbox for Test",
- "overrideMetadata": true,
- "excludeFromSearch": false,
- "groupAdminProfile": [
- "main_grp_admin"
], - "groups": [
- "barring_grp1",
- "barring_grp2",
- "test_grp2",
- "test_grp1"
], - "groupInboxPin": "4356",
- "groupInboxPromptId": "Welcome",
- "allowAnonymousCallers": false,
- "smsGroups": [
- "test_grp1",
- "test_grp3"
], - "emailGroups": [
- "test_grp1",
- "test_grp2"
], - "retentionTime": 14,
- "maxInboxSize": 155,
- "fileAttached": false,
- "playOldestMessageFirst": true,
- "searchableBySAA": true,
- "saaAliases": [
- {
- "value": "Group Inbox Number",
- "language": "en"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Group Inbox number
Creates a Group Inbox number. Adding, removing or modifying a group inbox can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.group.missing - the specified group is missing
organization.invalid.asr.language - the language id stated in an saaAlias instance is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - the names stated in an saaAlias instance contain unsupported characters for the language specified
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| excludeFromSearch required | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| groupInboxPin required | string Code that identifies this group inbox when calling a group inbox retrieval number. |
| groupInboxPromptId required | string The voice prompt that is played to caller before voicemail is recorded. |
| maxInboxSize required | integer <int32> [ 1 .. 250 ] The max size of all messages stored in the inbox in megabytes |
| name required | string The name of the function number. |
| retentionTime required | integer <int32> [ 1 .. 40 ] The number of days that old messages should be saved before they are automatically deleted |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| groups | Array of strings List of User Groups that can answer the calls or barring groups that should apply for this number. |
| allowAnonymousCallers | boolean Allow a caller that is calling anonymously to retrieve messages of this group inbox after being prompted for personal number and pin. |
| smsGroups | Array of strings One or many user groups whose users will receive SMS notifications when new messages are deposited in the group inbox. |
| emailGroups | Array of strings One or many user groups whose users will receive E-mail notifictions when new messages are deposited in the group inbox. Note that the message will not be included as an attachment to the E-mail. |
| searchableBySAA | boolean Whether the group inbox number is searchable by Speech Auto Attendant or not. Note that the number must also be enabled by an SAA profile to be reached |
Array of objects List of Speech Auto Attendant aliases. | |
| fileAttached | boolean Controls if message voice files should be attached to email notifications |
| playOldestMessageFirst | boolean Controls if the messages should be played from oldest to newest when listening to the inbox |
Responses
Request samples
- Payload
{ "fnr": "+46765964122", "name": "Group Inbox for Test", "overrideMetadata": true, "excludeFromSearch": false, "groupAdminProfile": [ "main_grp_admin" ], "groups": [ "barring_grp1", "barring_grp2", "test_grp3", "test_grp2", "test_grp1" ], "groupInboxPin": "4356", "groupInboxPromptId": "Welcome", "allowAnonymousCallers": false, "smsGroups": [ "test_grp1", "test_grp3" ], "emailGroups": [ "test_grp1", "test_grp2", "test_grp3" ], "retentionTime": 12, "maxInboxSize": 55, "fileAttached": true, "playOldestMessageFirst": true, "searchableBySAA": true, "saaAliases": [ { "value": "Group Inbox Number", "language": "en" } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Hunt Group API is used to manage Hunt group numbers.
Use the Hunt Group API to:
- Create hunt groups
- Get hunt groups
- Update hunt groups
- Delete hunt groups
Get Hunt Group
Use this method to get an existing Hunt group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "id": 19,
- "fnr": "+46899995020",
- "name": "HuntGroup1",
- "overrideMetadata": false,
- "excludeFromSearch": true,
- "distributionLogic": "SEQUENTIAL",
- "preferredNumberType": "DIVERSION_NUMBER",
- "billingId": "+46899995020",
- "fallbackNr": "+46899995010",
- "fallbackWhenClosed": true,
- "huntLength": 0,
- "huntDuration": 0,
- "huntForwardingLength": 10,
- "huntExclusionInCall": true,
- "huntDontAddDiversion": false,
- "featureCodeIdentifier": "4231",
- "groups": [ ],
- "distribution": [
- "SOFTPHONE"
], - "excludedActivities": [
- "Lunch",
- "Away"
], - "excludedRoles": [
- "Private"
], - "searchableBySAA": false
}Update Hunt Group
See API to create Hunt Group for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The phone number of the function number |
Request Body schema: required
| distributionLogic required | string Enum: "PARALLEL" "SEQUENTIAL" If the distribution should be done in parallel or sequentially to the members. |
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| fallbackNr | string The number that incoming calls to the hunt group should be forwarded to, in case the hunt length is exceeded without anyone answering, or if no user exists that is not excluded from the hunt. If no fallback number is set, a user unavailable error signal is played. |
| fallbackWhenClosed | boolean When enabled, calls will be forwarded to fallback number when the function number is closed according to the schedules. If the active schedule has a voice prompt configured, it will be played prior to forwarding. |
| huntLength | integer <int32> The amount of users that are associated with the hunt group and not excluded by activity, call state or role that the call is distributed to. If none of these users answer the call, the incoming call will be forwarded to the fallback number fallbackNr. |
| huntDuration | integer <int32> The number of seconds the phone should ring for one user until the phone stops ringing. The call can be forked to another user before the phone stops ringing, so that the phone rings at multiple locations. |
| huntForwardingLength | integer <int32> Number of seconds before forking the call to the next user in the hunt group. |
| huntExclusionInCall | boolean Whether a user in call is excluded from the hunt, true or false. |
| huntDontAddDiversion | boolean Whether diversion number should not be added (for billing purposes when breaking out on SIP trunks for mobile numbers when having an internal number for the hunt group number), true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| excludedActivities | Array of strings An activity that excludes a user from being part of the hunt. |
| excludedRoles | Array of strings A role that excludes a user from being part of the hunt. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects (LocalizedStringValue) A collection of names by which this group number is recognized by Speech Auto Attendant services. |
Responses
Request samples
- Payload
{- "id": 19,
- "name": "HuntGroup1",
- "overrideMetadata": false,
- "excludeFromSearch": true,
- "distributionLogic": "SEQUENTIAL",
- "preferredNumberType": "DIVERSION_NUMBER",
- "billingId": "+46899995020",
- "fallbackNr": "+46899995010",
- "fallbackWhenClosed": true,
- "huntLength": 0,
- "huntDuration": 0,
- "huntForwardingLength": 10,
- "huntExclusionInCall": true,
- "huntDontAddDiversion": false,
- "featureCodeIdentifier": "4231",
- "groups": [ ],
- "distribution": [
- "SOFTPHONE"
], - "excludedActivities": [
- "Lunch",
- "Away"
], - "excludedRoles": [
- "Private"
], - "searchableBySAA": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Hunt Group
Adding, removing or modifying a hunt group can cause the following errors:
fnr.missing.name - Function number name is missing
fnr.missing.huntGroup.distributionLogic - Distribution Logic is missing for Hunt Group
fnr.missing.localizedValue.language - Language is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.missing.localizedValue.value - Value is not provided for the localizedValue in Speech Auto Attendant aliases
fnr.featureCodeIdentifier.invalid - the feature code ID is already in use
int.value.invalid - the feature code ID must be an integer value greater than 0
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.group.missing - the specified group is missing
fnr.invalid.distribution - a specified device under distribution is not valid
fnr.invalid.presenceState - a specified role or activity does not exist
fnr.invalid.distlength - invalid value for huntForwardingLength
fnr.invalid.huntduration - invalid value for huntDuration
fnr.invalid.billingid - the specified billing id is not within a configured billing range
organization.invalid.asr.language - the language id stated in an saaAlias instance is not valid for Speech Auto Attendant services in this organization
organization.invalid.asr.expression - the names stated in an saaAlias instance contain unsupported characters for the language specified
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The phone number of the function number |
Request Body schema: required
| distributionLogic required | string Enum: "PARALLEL" "SEQUENTIAL" If the distribution should be done in parallel or sequentially to the members. |
| groups required | Array of strings The User Groups that can answer the calls or barring groups that should apply for this number. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| excludeFromSearch | boolean Whether or not the group is excluded from searches in the directory, true or false. |
| preferredNumberType | string Enum: "DIVERSION_NUMBER" "CALLING_PARTY" How the calling party number is displayed to the receiver when calls are redirected to phones that can't show diversion information (i.e. mobile phones). If set to DIVERSION_NUMBER, the group number will be displayed to the receiver instead of the original calling party number. If set to CALLING_PARTY, the number will be presented as the calling party number with a redirection number prefix and/or suffix added to the displayed number. Prefix is set within groupNumberPrefix and suffix is set within groupNumberSuffix. |
| groupNumberPrefix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The prefix number is added to the caller information displayed to the receiver. |
| groupNumberSuffix | string Only present and used if preferredNumberType is set to CALLING_PARTY. The suffix number is added to the caller information displayed to the receiver. |
| billingId | string The billing ID used with outgoing calls for this function number. Any source tags associated with the billing ID will be applied. |
| fallbackNr | string The number that incoming calls to the hunt group should be forwarded to, in case the hunt length is exceeded without anyone answering, or if no user exists that is not excluded from the hunt. If no fallback number is set, a user unavailable error signal is played. |
| fallbackWhenClosed | boolean When enabled, calls will be forwarded to fallback number when the function number is closed according to the schedules. If the active schedule has a voice prompt configured, it will be played prior to forwarding. |
| huntLength | integer <int32> The amount of users that are associated with the hunt group and not excluded by activity, call state or role that the call is distributed to. If none of these users answer the call, the incoming call will be forwarded to the fallback number fallbackNr. |
| huntDuration | integer <int32> The number of seconds the phone should ring for one user until the phone stops ringing. The call can be forked to another user before the phone stops ringing, so that the phone rings at multiple locations. |
| huntForwardingLength | integer <int32> Number of seconds before forking the call to the next user in the hunt group. |
| huntExclusionInCall | boolean Whether a user in call is excluded from the hunt, true or false. |
| huntDontAddDiversion | boolean Whether diversion number should not be added (for billing purposes when breaking out on SIP trunks for mobile numbers when having an internal number for the hunt group number), true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| distribution | Array of strings Which personal phone types the calls are distributed to. The personal call routing rules for the agent are not applied. The available devices are: SOFTPHONE, DESKPHONE, MOBILE, ANALOG, EXTERNAL_PBX and TEAMS. |
| excludedActivities | Array of strings An activity that excludes a user from being part of the hunt. |
| excludedRoles | Array of strings A role that excludes a user from being part of the hunt. |
| searchableBySAA | boolean Whether or not this group number can be searched by Speech Auto Attendant services, true or false. |
Array of objects (LocalizedStringValue) A collection of names by which this group number is recognized by Speech Auto Attendant services. |
Responses
Request samples
- Payload
{- "name": "HuntGroup1",
- "overrideMetadata": false,
- "excludeFromSearch": true,
- "distributionLogic": "PARALLEL",
- "preferredNumberType": "DIVERSION_NUMBER",
- "billingId": "+46899995020",
- "fallbackWhenClosed": false,
- "huntLength": 3,
- "huntDuration": 30,
- "huntForwardingLength": 10,
- "huntExclusionInCall": true,
- "huntDontAddDiversion": false,
- "groups": [ ],
- "searchableBySAA": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Interactive Voice Response API is used to manage interactive voice response numbers.
Use the Interactive Voice Response API to:
- Create IVR numbers
- Get IVR numbers
- Update IVR numbers
- Delete IVR numbers
Get IVR number
Use this method to get an existing IVR number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Responses
Response samples
- 200
{- "barringGroups": [
- "Internal"
], - "noExtensionFoundDest": "+46899995080",
- "dialedExtension": true,
- "billingId": "+46899995100",
- "extensionDialingPrompt": "system_wrong_nr",
- "extensionDialingPrefix": "5",
- "name": "IVR number",
- "menu": [
- {
- "key": "to",
- "number": "+46899995080"
}
], - "featureCodeIdentifier": "3943",
- "prompt": "system_welcome",
- "preserveMetadata": true
}Update IVR number
See API to create IVR number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: */*required
| name required | string The name of the IVR number. |
| prompt required | string The voice prompt id that should be played calling the group. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| groupAdminProfile | Array of strings Group administrator profile. Group administrators having this profile enabled can administrate this function number. |
| extensionDialingPrompt | string The prompt id that should be played as an error prompt in extension dialing. Setting extensionDialingPrompt enables extension dialing for this IVR number. |
| extensionDialingPrefix | string The dialed extension numbers should be prefixed by this prefix. |
Array of objects (MenuChoice) The menu choice sets the key-number mappings for the IVR. You can add multiple choices within the menu tag. | |
| featureCodeIdentifier | string Feature code identifier (optional). Code that identifies this function number when using feature codes. |
| preserveMetadata | boolean Boolean whether to preserve meta-data from a diverted call. Can be true or false. |
Responses
Request samples
- Payload
{ "barringGroups": [ "Internal" ], "noExtensionFoundDest": "+46899995080", "dialedExtension": true, "billingId": "+46899995100", "extensionDialingPrompt": "system_wrong_nr", "extensionDialingPrefix": "5", "name": "IVR number", "menu": [ { "key": "to", "number": "+46899995080" } ], "featureCodeIdentifier": "3943", "prompt": "system_welcome", "preserveMetadata": true }
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create IVR number
Adding, removing or modifying an IVR number can cause the following errors:
fnr.featureCodeIdentifier.invalid - the feature code ID is already in use
int.value.invalid - the feature code ID must be an integer value greater than 0
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.group.missing - the specified barring group is missing
fnr.invalid.ivr.choice - invalid key attribute for choice
fnr.invalid.prompt - invalid prompt id
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The phone number of the function number |
Request Body schema: */*required
| name required | string The name of the IVR number. |
| prompt required | string The voice prompt id that should be played calling the group. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| groupAdminProfile | Array of strings Group administrator profile. Group administrators having this profile enabled can administrate this function number. |
| extensionDialingPrompt | string The prompt id that should be played as an error prompt in extension dialing. Setting extensionDialingPrompt enables extension dialing for this IVR number. |
| extensionDialingPrefix | string The dialed extension numbers should be prefixed by this prefix. |
Array of objects (MenuChoice) The menu choice sets the key-number mappings for the IVR. You can add multiple choices within the menu tag. | |
| featureCodeIdentifier | string Feature code identifier (optional). Code that identifies this function number when using feature codes. |
| preserveMetadata | boolean Boolean whether to preserve meta-data from a diverted call. Can be true or false. |
Responses
Request samples
- Payload
{ "barringGroups": [ "Internal" ], "noExtensionFoundDest": "+46899995080", "dialedExtension": true, "billingId": "+46899995100", "extensionDialingPrompt": "system_wrong_nr", "extensionDialingPrefix": "5", "name": "IVR number", "menu": [ { "key": "to", "number": "+46899995080" } ], "featureCodeIdentifier": "3943", "prompt": "system_welcome", "preserveMetadata": true }
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Rule Based Number API is a group of methods to manage rule based numbers.
Use the Rule based number API to:
- Get a Rule based number
- Create a Rule based number
- Update a Rule based number
- Delete a Rule based number
Get rule based number
Fetches a Rule Based number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "id": 10,
- "fnr": "+46840837751",
- "name": "PublicRBN",
- "metadata": "PublicRBN meta data",
- "overrideMetadata": false,
- "displayString": "PublicRBN (+46840837751)",
- "locale": "en",
- "preferDiversionAsANumber": false,
- "defaultForwardNumber": "+565656",
- "billingId": "+46840837751",
- "barringGroups": [
- "barring_grp1",
- "barring_grp2"
]
}Update rule based number
Update an existing Rule Based number. See API to create Rule-Based Number for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| locale required | string A string with the two-char locale name to be used in the prompts. The locale needs to be enabled for the organization. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| preferDiversionAsANumber | boolean Boolean if the group number should be presented as calling party number when the redirection number cannot be signaled to the receiver, for example when calls are redirected to mobile phones. If true, the calling party number of these destinations will be the ACD number instead of the original calling party number. |
| defaultForwardNumber | string The default forward number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Array of objects (rule) List of rules |
Responses
Request samples
- Payload
{- "id": 10,
- "fnr": "+46840837751",
- "name": "PublicRBN",
- "metadata": "PublicRBN meta data update",
- "overrideMetadata": false,
- "displayString": "PublicRBN (+46840837751)",
- "locale": "en",
- "preferDiversionAsANumber": false,
- "defaultForwardNumber": "+46840837888",
- "billingId": "+46840837751",
- "barringGroups": [
- "barring_grp1",
- "barring_grp2",
- "barring_grp3"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create rule based number
Creates a Rule Based number. Adding, removing or modifying a rule based number can cause the following errors:
fnr.number.inuse - not possible to create a new group with the number as it is already in use
fnr.number.out.of.range - not possible to create a new group with the number as it is outside of the number ranges of the organization
fnr.invalid.billingid - the specified billing id is not within a configured billing range
fnr.group.missing - the specified barring group is missing
fnr.invalid.locale - invalid locale for the organization
xml.invalid - the XML does not validate against the schema
missing.field - a mandatory field is missing
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: required
| locale required | string A string with the two-char locale name to be used in the prompts. The locale needs to be enabled for the organization. |
| name required | string The name of the function number. |
| id | integer <int64> The id of the function number. |
| metadata | string The metadata for the group. The metadata will be shown to the agent receiving the incoming call. |
| overrideMetadata | boolean Whether to override metadata or not. Can be true or false. |
| featureCodeIdentifier | string The feature code ID for the group. |
| preferDiversionAsANumber | boolean Boolean if the group number should be presented as calling party number when the redirection number cannot be signaled to the receiver, for example when calls are redirected to mobile phones. If true, the calling party number of these destinations will be the ACD number instead of the original calling party number. |
| defaultForwardNumber | string The default forward number. |
| billingId | string The billing id used with outgoing calls for this function number. Any source tags associated with the billing id will be applied. |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Array of objects (rule) List of rules |
Responses
Request samples
- Payload
{- "fnr": "+46840837751",
- "name": "PublicRBN",
- "metadata": "PublicRBN meta data",
- "overrideMetadata": false,
- "displayString": "PublicRBN (+46840837751)",
- "locale": "en",
- "preferDiversionAsANumber": false,
- "defaultForwardNumber": "+565656",
- "billingId": "+46840837751",
- "barringGroups": [
- "barring_grp1",
- "barring_grp2"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Function Number Schedule API is used to manage function number schedules.
Use the Function Number Schedule API to:
- Create schedules for a function number
- Get current schedule for a function number
- Get time zone for a function number
- List schedules for a function number
- List schedules for all function numbers
- Update schedules for a function number
- Update time zone for a function number
Get opening hours
Get the opening hours configured using schedules for this function number.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, can be either true or false, if omitted the timestamp will be presented in UTC time zone. |
Responses
Response samples
- 200
{- "timeZoneId": "Europe/Stockholm",
- "openingHoursList": [
- {
- "name": "Open",
- "start": {
- "time": 18000000
}, - "end": {
- "time": 82799000
}, - "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
], - "breaks": [
- {
- "name": "Lunch",
- "start": {
- "time": 43200000
}, - "end": {
- "time": 46800000
}
}
]
}
], - "prompt": "system_welcome",
- "breakAction": "CLOSED",
- "breakHangup": true,
- "breakPrompt": "system_lunch_greeting"
}Update opening hours
Set the opening hours schedules for a specific function number. Note that the events generated for the opening hours is not possible to modify via the standard methods in this API or via the UI.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, either true or false, if omitted the timestamp will be presented in UTC time zone. |
Request Body schema: application/jsonrequired
required | Array of objects (OpeningHoursDTO) List of opening hours for a week. May contain 1 to 7 elements which recurrence may not overlap. |
| timeZoneId required | string The time zone ID of the function number |
| prompt | string Prompt to play when open. |
| breakAction | string Enum: "OPEN" "CLOSED" "FORWARD" The action for the break, only CLOSED and FORWARD are valid. Applies to all breaks. |
| breakHangup | boolean Determining if the queue should be hung up or not during the breaks. Applies to all break. |
| breakForwardNumber | string Number to forward to. Mandatory when breakAction is FORWARD. Applies to all breaks. |
| breakPrompt | string Prompt to play during break. Applies to all breaks. |
Responses
Request samples
- Payload
{- "timeZoneId": "Europe/Stockholm",
- "openingHoursList": [
- {
- "name": "Open",
- "start": {
- "time": 18000000
}, - "end": {
- "time": 82799000
}, - "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
], - "breaks": [
- {
- "name": "Lunch",
- "start": {
- "time": 43200000
}, - "end": {
- "time": 46800000
}
}
]
}
], - "prompt": "system_welcome",
- "breakAction": "CLOSED",
- "breakHangup": true,
- "breakPrompt": "system_lunch_greeting"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create opening hours
Set the opening hours schedules for a specific function number. Note that the events generated for the opening hours is not possible to modify via the standard methods in this API or via the UI.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, either true or false, if omitted the timestamp will be presented in UTC time zone. |
Request Body schema: application/jsonrequired
required | Array of objects (OpeningHoursDTO) List of opening hours for a week. May contain 1 to 7 elements which recurrence may not overlap. |
| timeZoneId required | string The time zone ID of the function number |
| prompt | string Prompt to play when open. |
| breakAction | string Enum: "OPEN" "CLOSED" "FORWARD" The action for the break, only CLOSED and FORWARD are valid. Applies to all breaks. |
| breakHangup | boolean Determining if the queue should be hung up or not during the breaks. Applies to all break. |
| breakForwardNumber | string Number to forward to. Mandatory when breakAction is FORWARD. Applies to all breaks. |
| breakPrompt | string Prompt to play during break. Applies to all breaks. |
Responses
Request samples
- Payload
{- "timeZoneId": "Europe/Stockholm",
- "openingHoursList": [
- {
- "name": "Open",
- "start": {
- "time": 18000000
}, - "end": {
- "time": 82799000
}, - "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
], - "breaks": [
- {
- "name": "Lunch",
- "start": {
- "time": 43200000
}, - "end": {
- "time": 46800000
}
}
]
}
], - "prompt": "system_welcome",
- "breakAction": "CLOSED",
- "breakHangup": true,
- "breakPrompt": "system_lunch_greeting"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List schedules
List the schedules for a specific function number.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, can be either true or false, if omitted the timestamp will be presented in UTC time zone. |
Responses
Response samples
- 200
{- "id": 1,
- "name": "Attendant",
- "number": "+46899995040",
- "type": "ATTENDANT",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}, - {
- "name": "Lunch",
- "limits": {
- "start": {
- "time": 43200000,
- "date": 1588932000000
}, - "end": {
- "time": 46800000,
- "date": 1596884400000
}, - "recurrenceType": "WEEKLY",
- "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
]
}, - "action": {
- "type": "CLOSED",
- "hangup": false,
- "prompt": "system_lunch_greeting",
- "disableRecordingPrompts": true
}
}, - {
- "name": "Forward",
- "limits": {
- "start": {
- "time": 61200000,
- "date": 1588950000000
}, - "recurrenceType": "DAILY"
}, - "action": {
- "type": "FORWARD",
- "hangup": false,
- "disableRecordingPrompts": false,
- "forwardNumber": "+46899995010"
}
}
]
}Update schedules
Update the schedules for a specific function number.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, either true or false, if omitted the timestamp will be presented in UTC time zone. |
Request Body schema: required
| id required | integer <int64> The id of the function number |
| name required | string The name of the function number |
| number required | string The phone number of the function number |
| timeZoneId required | string The time zone ID of the function number |
| type required | string Enum: "ACD" "ACD_LIGHT" "ATTENDANT" "CONFERENCE" "IVR_MENU" "VOICEMAIL_RETRIEVAL" "FAX_NUMBER" "RULE_BASED" "HUNT_GROUP" "SHARED_LINE" "EXTERNAL_SYSTEM" "GROUP_INBOX" "GROUP_INBOX_RETRIEVAL" "AUTO_ATTENDANT" The type of the function number |
| currentActionType | string Enum: "OPEN" "CLOSED" "FORWARD" The current status of the function number |
Array of objects (ScheduleDTO) List of schedules for the function number |
Responses
Request samples
- Payload
{- "id": 1,
- "name": "Attendant",
- "number": "+46899995040",
- "type": "ATTENDANT",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}, - {
- "name": "Lunch",
- "limits": {
- "start": {
- "time": 43200000,
- "date": 1588932000000
}, - "end": {
- "time": 46800000,
- "date": 1596884400000
}, - "recurrenceType": "WEEKLY",
- "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
]
}, - "action": {
- "type": "CLOSED",
- "hangup": false,
- "prompt": "system_lunch_greeting",
- "disableRecordingPrompts": true
}
}, - {
- "name": "Forward",
- "limits": {
- "start": {
- "time": 61200000,
- "date": 1588950000000
}, - "recurrenceType": "DAILY"
}, - "action": {
- "type": "FORWARD",
- "hangup": false,
- "disableRecordingPrompts": false,
- "forwardNumber": "+46899995010"
}
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create schedules
Set the schedules for a specific function number.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, either true or false, if omitted the timestamp will be presented in UTC time zone. |
Request Body schema: required
| id required | integer <int64> The id of the function number |
| name required | string The name of the function number |
| number required | string The phone number of the function number |
| timeZoneId required | string The time zone ID of the function number |
| type required | string Enum: "ACD" "ACD_LIGHT" "ATTENDANT" "CONFERENCE" "IVR_MENU" "VOICEMAIL_RETRIEVAL" "FAX_NUMBER" "RULE_BASED" "HUNT_GROUP" "SHARED_LINE" "EXTERNAL_SYSTEM" "GROUP_INBOX" "GROUP_INBOX_RETRIEVAL" "AUTO_ATTENDANT" The type of the function number |
| currentActionType | string Enum: "OPEN" "CLOSED" "FORWARD" The current status of the function number |
Array of objects (ScheduleDTO) List of schedules for the function number |
Responses
Request samples
- Payload
{- "id": 1,
- "name": "Attendant",
- "number": "+46899995040",
- "type": "ATTENDANT",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}, - {
- "name": "Lunch",
- "limits": {
- "start": {
- "time": 43200000,
- "date": 1588932000000
}, - "end": {
- "time": 46800000,
- "date": 1596884400000
}, - "recurrenceType": "WEEKLY",
- "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
]
}, - "action": {
- "type": "CLOSED",
- "hangup": false,
- "prompt": "system_lunch_greeting",
- "disableRecordingPrompts": true
}
}, - {
- "name": "Forward",
- "limits": {
- "start": {
- "time": 61200000,
- "date": 1588950000000
}, - "recurrenceType": "DAILY"
}, - "action": {
- "type": "FORWARD",
- "hangup": false,
- "disableRecordingPrompts": false,
- "forwardNumber": "+46899995010"
}
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get current schedule
Read the current schedules for a specific function number.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| useLocalTimeZoneTimestamps | boolean If timestamps should be presented in local time zone. If true, timestamps will be presented in the local time zone, otherwise, they will be presented in UTC time. |
Responses
Response samples
- 200
No active event
{- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}List all schedules
Retrieve the schedules for all functional numbers.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| useLocalTimeZoneTimestamps | boolean If the time stamps should be presented in local or UTC time zone, either true or false, if omitted the timestamp will be presented in UTC time zone. |
Responses
Response samples
- 200
{- "functionNumberSchedule": [
- {
- "id": 1,
- "name": "Attendant",
- "number": "+46899995040",
- "type": "ATTENDANT",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}, - {
- "name": "Lunch",
- "limits": {
- "start": {
- "time": 43200000,
- "date": 1588932000000
}, - "end": {
- "time": 46800000,
- "date": 1596884400000
}, - "recurrenceType": "WEEKLY",
- "recurrence": [
- 1,
- 1,
- 1,
- 1,
- 1,
- 0,
- 0
]
}, - "action": {
- "type": "CLOSED",
- "hangup": false,
- "prompt": "system_lunch_greeting",
- "disableRecordingPrompts": true
}
}, - {
- "name": "Forward",
- "limits": {
- "start": {
- "time": 61200000,
- "date": 1588950000000
}, - "recurrenceType": "DAILY"
}, - "action": {
- "type": "FORWARD",
- "hangup": false,
- "disableRecordingPrompts": false,
- "forwardNumber": "+46899995010"
}
}
]
}, - {
- "id": 5,
- "name": "HuntGroup",
- "number": "+46899995050",
- "type": "HUNT_GROUP",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}, - {
- "name": "Swedish National Day",
- "limits": {
- "start": {
- "time": 18000000,
- "date": 1591394400000
}, - "end": {
- "time": 82799000,
- "date": 1591480799000
}
}, - "action": {
- "type": "CLOSED",
- "hangup": false,
- "prompt": "1252487359344",
- "disableRecordingPrompts": false
}
}, - {
- "name": "Forward",
- "limits": {
- "start": {
- "time": 61200000,
- "date": 1588950000000
}, - "recurrenceType": "DAILY"
}, - "action": {
- "type": "FORWARD",
- "hangup": false,
- "disableRecordingPrompts": false,
- "forwardNumber": "+46899995010"
}
}
]
}, - {
- "id": 7,
- "name": "IVR",
- "number": "+46899995060",
- "type": "IVR_MENU",
- "currentActionType": "OPEN",
- "timeZoneId": "Europe/Stockholm",
- "schedules": [
- {
- "name": "default",
- "limits": {
- "recurrenceType": "NONE"
}, - "action": {
- "type": "OPEN",
- "hangup": false,
- "disableRecordingPrompts": false
}
}
]
}
]
}Update time zone
Update the time zone for a specific function number.
Available time zones can be listed by using the Timezone API.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| number required | string The function number |
query Parameters
| timezoneId required | string The time zone |
| adjustDates | string If timestamps should be adjusted according to the new time zone, can be either true or false, if omitted it will be treated as false is given. |
Responses
The Voicemail API is a group of methods to manage voice mail numbers.
Use the Voicemail API to:
- Get voicemail number
- Create voicemail number
- Create voicemail number with barring groups
- Update voicemail number
- Delete voicemail number
Get Voicemail number
Fetches Voicemailbox number.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Responses
Response samples
- 200
- 400
{- "number": "+46765959191",
- "barringGroups": [
- "test_grp1",
- "test_grp2"
]
}Update Voicemail number
Updates a Voicemail retrieval number. See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| number | string Voicemail Number is used to access the voicemail service from a phone |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Responses
Request samples
- Payload
{ "number": "+46765959000", "barringGroups": [ "barring1", "barring2" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Voicemail number
Creates a Voicemail retrieval number. See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| number | string Voicemail Number is used to access the voicemail service from a phone |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Responses
Request samples
- Payload
{ "number": "+46765959000" }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create Voicemail number with barring groups
Creates a Voicemail retrieval number with barring groups. See API to create conference for possible error codes.
Authorizations:
path Parameters
| domain required | string The domain of the organization the function number belongs to |
| number required | string The function number |
Request Body schema: */*required
| number | string Voicemail Number is used to access the voicemail service from a phone |
| barringGroups | Array of strings The barring groups that should apply for this function number. |
Responses
Request samples
- Payload
{ "number": "+46765959000", "barringGroups": [ "barring1", "barring2" ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The CRM Connector API is used to manage settings to restrict sharing of user's personal data to a CRM system.
Use the CRM Connector API to:
- Get CRM connector configurations
- Update CRM connector configurations
- Reset CRM connector
Get CRM Connector
Retrieves the CRM Connector Webhook configurations of the organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
Masked numbers
{- "removeLocalNumber": false,
- "removeLocalUser": false,
- "removeLocalEmail": false,
- "maskLocalNumber": true,
- "maskLocalNumberDigits": 5,
- "removeRemoteNumber": false,
- "removeRemoteUser": false,
- "removeRemoteEmail": true,
- "maskRemoteNumber": true,
- "maskRemoteNumberDigits": 3,
- "removeDeviceType": false
}Update CRM Connector
Creates/updates CRM Connector Webhook for the organization. Connector configurations for the organization will be overwritten if exists.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: required
| url | string The URL to the 3rd party CRM system. |
| removeLocalNumber | boolean Whether the local caller's number shall be removed from the response information, or not. |
| removeLocalUser | boolean Whether the user ID shall be removed from the response information, or not. |
| removeLocalEmail | boolean Whether the local caller's email address shall be removed, or not. |
| maskLocalNumber | boolean Whether the local caller's number shall be masked, or not. |
| maskLocalNumberDigits | integer <int32> Number of digits to mask in local caller's number. |
| removeRemoteNumber | boolean Whether the remote party's number shall be removed, or not. |
| removeRemoteUser | boolean Whether the remote party's user ID shall be removed, or not. |
| removeRemoteEmail | boolean Whether the remote party's email address shall be removed, or not. |
| maskRemoteNumber | boolean Whether the remote party's number shall be masked, or not. |
| maskRemoteNumberDigits | integer <int32> Number of digits to mask in remote party's number. |
| removeDeviceType | boolean Whether the device information shall be removed, or not. |
Responses
Request samples
- Payload
Masked numbers
{- "removeLocalNumber": false,
- "removeLocalUser": false,
- "removeLocalEmail": false,
- "maskLocalNumber": true,
- "maskLocalNumberDigits": 4,
- "removeRemoteNumber": false,
- "removeRemoteUser": false,
- "removeRemoteEmail": false,
- "maskRemoteNumber": true,
- "maskRemoteNumberDigits": 5,
- "removeDeviceType": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Calendar Connector API is used to manage calendar connectors.
Use the Calendar Connector API to:
- Create calendar connector
- Get calendar connector
- List calendar connectors
- Update calendar connector
- Delete calendar connector
Create connector
Create a calendar connector.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the calendar connector |
Request Body schema: required
| name | string <= 64 characters The name of the calendar connector. |
| useProxy | boolean Whether a proxy is used or not when connecting to the external server. |
| useAutodiscover | boolean Whether autodiscover functions are present at the external connector or not and if they shall be used. |
| organizationId | integer <int32> The id of the organization. |
| connectorType | string Enum: "EXCHANGE_2007_SP1" "EXCHANGE_2007_SP2" "EXCHANGE_2007_SP3" "EXCHANGE_2010" "EXCHANGE_2010_SP1" "EXCHANGE_2010_SP2" "EXCHANGE_2010_SP3" "EXCHANGE_2013" "EXCHANGE_2013_SP1" "EXCHANGE_OFFICE_365" "EXCHANGE_2016" "EXCHANGE_2019" "GOOGLE_WORKSPACE" The connector type. |
| serverUrl | string The URL to the external connector. |
| authenticationMethod | string Enum: "BASIC" "NTLM" "OAUTH2" "UNKNOWN" The authentication method. |
| user | string The username to log in with on the external connector. Not used for Google Workspace. |
| password | string <= 64 characters The password to log in with on the external connector. |
| clientSecret | string The password to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| applicationClientId | string The application client id to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| directoryTenantId | string The tenant to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| connectionData | string Opaque connection data, in (base64) encoded String form. Currently only used for Google Workspace connectors. |
| syncAheadDays | integer <int32> Default: 1 The number of days ahead to sync presence state information of users. |
| enableExchangeContactSearch | boolean Whether Office365 contact search is enabled or not when connecting to the Exchange server. It is only valid for Exchange Office 365 calendar connector |
| id | integer <int64> The id of the calendar connector. |
| enableVirtualMeetingRoom | boolean True if the calendar connector should provide a virtual meeting room. |
| virtualMeetingRoomAddress | string The email address of the virtual meeting room. |
| enableVirtualMeetingRoomSmsReminders | boolean True if reminders should be sent as SMS in addition to as email. |
Responses
Request samples
- Payload
{- "name": "Office 365",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_OFFICE_365",
- "authenticationMethod": "OAUTH2",
- "user": "exg365@example.onmicrosoft.com",
- "clientSecret": "lhn49wwqiqI62FI@G:lphGF??O@TI[Yo",
- "applicationClientId": "24b13ef2-91b7-7a5d-96e7-ac16fa1fc370",
- "directoryTenantId": "bf3b50ec-ead9-417b-b642-d8d35fdc2ca7",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": true
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get connector
Retrieve information for the specified calendar connector.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the calendar connector |
Responses
Response samples
- 200
{- "name": "Office 365",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_OFFICE_365",
- "authenticationMethod": "OAUTH2",
- "user": "exg365@example.onmicrosoft.com",
- "clientSecret": "lhn49wwqiqI62FI@G:lphGF??O@TI[Yo",
- "applicationClientId": "24b13ef2-91b7-7a5d-96e7-ac16fa1fc370",
- "directoryTenantId": "bf3b50ec-ead9-417b-b642-d8d35fdc2ca7",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": true,
- "id": 47
}List connectors
List all calendar connectors.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "calendarConnector": [
- {
- "name": "Office 365",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_OFFICE_365",
- "authenticationMethod": "OAUTH2",
- "user": "exg365@example.onmicrosoft.com",
- "clientSecret": "lhn49wwqiqI62FI@G:lphGF??O@TI[Yo",
- "applicationClientId": "24b13ef2-91b7-7a5d-96e7-ac16fa1fc370",
- "directoryTenantId": "bf3b50ec-ead9-417b-b642-d8d35fdc2ca7",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": true,
- "id": 47
}, - {
- "name": "My Google Workspace Connector",
- "useProxy": true,
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "GOOGLE_WORKSPACE",
- "authenticationMethod": "UNKNOWN",
- "connectionData": "IyBwYWxhbnRpci1qYXZhLWZvcm1hdCBFY2xpcHNlIFBsdWdpbgoKIyMgSW5zdGFsbGF0aW9uCgoxLiBSdW4gYC4vZ3JhZGxldyA6ZWNsaXBzZV9wbHVnaW46YnVpbGRgIGluIHRoZSBtYWluIGZvbGRlciwKMS4gSWYgcnVubmluZyBFY2xpcHNlIHVuZGVyIEpSRSAxNyBvciBsYXRlciBhZGQgdGhlc2Ugb3B0aW9ucyB0byBgZWNsaXBzZS5pbmlgIGFmdGVyIGAtdm1hcmdzYDoKICAgYGBgCiAgIC0tYWRkLWV4cG9ydHMKICAgamRrLmNvbXBpbGVyL2NvbS5zdW4udG9vbHMuamF2YWMuYXBpPUFMTC1VTk5BTUVECiAgIC0tYWRkLWV4cG9ydHMKICAgamRrLmNvbXBpbGVyL2NvbS5zdW4udG9vbHMuamF2YWMuZmlsZT1BTEwtVU5OQU1FRAogICAtLWFkZC1leHBvcnRzCiAgIGpkay5jb21waWxlci9jb20uc3VuLnRvb2xzLmphdmFjLnBhcnNlcj1BTEwtVU5OQU1FRAogICAtLWFkZC1leHBvcnRzCiAgIGpkay5jb21waWxlci9jb20uc3VuLnRvb2xzLmphdmFjLnRyZWU9QUxMLVVOTkFNRUQKICAgLS1hZGQtZXhwb3J0cwogICBqZGsuY29tcGlsZXIvY29tLnN1bi50b29scy5qYXZhYy51dGlsPUFMTC1VTk5BTUVECiAgIGBgYAoxLiBDb3B5IGBidWlsZC9saWJzL3BhbGFudGlyLWphdmEtZm9ybWF0LWVjbGlwc2UtcGx1Z2luLTx2ZXJzaW9uPi5qYXJgIHRvIHRoZSBgZHJvcGluc2AgZm9sZGVyIG9mIHlvdXIgRWNsaXBzZSBpbnN0YWxsYXRpb24sCjEuIFJ1biBgZWNsaXBzZSAtY2xlYW5gLg==",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": false,
- "id": 52,
- "enableVirtualMeetingRoom": false,
- "enableVirtualMeetingRoomSmsReminders": false
}, - {
- "name": "Exchange 2016",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_2016",
- "authenticationMethod": "NTLM",
- "user": "exg2016@example.org",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": false,
- "id": 35,
- "enableVirtualMeetingRoom": false
}, - {
- "name": "Exchange 2019",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_2019",
- "authenticationMethod": "NTLM",
- "user": "exg2019@example.org",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": false,
- "id": 52,
- "enableVirtualMeetingRoom": false
}
]
}Update connector
Update settings for a calendar connector.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the calendar connector |
Request Body schema: required
| name | string <= 64 characters The name of the calendar connector. |
| useProxy | boolean Whether a proxy is used or not when connecting to the external server. |
| useAutodiscover | boolean Whether autodiscover functions are present at the external connector or not and if they shall be used. |
| organizationId | integer <int32> The id of the organization. |
| connectorType | string Enum: "EXCHANGE_2007_SP1" "EXCHANGE_2007_SP2" "EXCHANGE_2007_SP3" "EXCHANGE_2010" "EXCHANGE_2010_SP1" "EXCHANGE_2010_SP2" "EXCHANGE_2010_SP3" "EXCHANGE_2013" "EXCHANGE_2013_SP1" "EXCHANGE_OFFICE_365" "EXCHANGE_2016" "EXCHANGE_2019" "GOOGLE_WORKSPACE" The connector type. |
| serverUrl | string The URL to the external connector. |
| authenticationMethod | string Enum: "BASIC" "NTLM" "OAUTH2" "UNKNOWN" The authentication method. |
| user | string The username to log in with on the external connector. Not used for Google Workspace. |
| password | string <= 64 characters The password to log in with on the external connector. |
| clientSecret | string The password to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| applicationClientId | string The application client id to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| directoryTenantId | string The tenant to use when connecting to Exchange Office 365 with OAuth2. Ignored for other types. |
| connectionData | string Opaque connection data, in (base64) encoded String form. Currently only used for Google Workspace connectors. |
| syncAheadDays | integer <int32> Default: 1 The number of days ahead to sync presence state information of users. |
| enableExchangeContactSearch | boolean Whether Office365 contact search is enabled or not when connecting to the Exchange server. It is only valid for Exchange Office 365 calendar connector |
| id | integer <int64> The id of the calendar connector. |
| enableVirtualMeetingRoom | boolean True if the calendar connector should provide a virtual meeting room. |
| virtualMeetingRoomAddress | string The email address of the virtual meeting room. |
| enableVirtualMeetingRoomSmsReminders | boolean True if reminders should be sent as SMS in addition to as email. |
Responses
Request samples
- Payload
{- "name": "Exchange 2016",
- "useAutodiscover": false,
- "organizationId": 15,
- "connectorType": "EXCHANGE_2016",
- "authenticationMethod": "NTLM",
- "user": "exg2016@example.org",
- "syncAheadDays": 1,
- "enableExchangeContactSearch": false,
- "id": 35,
- "enableVirtualMeetingRoom": false
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete connector
Delete a calendar connector.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of the calendar connector |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Enterprise SIP trunk API is used to connect external telephony systems that enable Dstny Core to communicate with remote systems.
Use the Enterprise SIP trunk API to:
- List Enterprise SIP trunks
- Create an Enterprise SIP trunk
- Update an Enterprise SIP trunk
- Read an Enterprise SIP trunk
- Delete Enterprise SIP trunk
- Create Enterprise SIP trunk rewrite
- Update Enterprise SIP trunk rewrite
- Delete Enterprise SIP trunk rewrite
- Get Enterprise SIP trunk rewrite
- Get Enterprise SIP trunk rewrites
- Get Enterprise SIP trunk status
Get trunk
Use this method to get an existing Enterprise SIP Trunk.
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of Enterprise SIP trunk |
Responses
Response samples
- 200
{- "deviceLocationName": "Default location",
- "name": "string",
- "connectorType": "SKYPE_FOR_BUSINESS_2019",
- "gateway": "INTERCONNECT_NODE",
- "active": true,
- "presenceHost": "test.com",
- "presencePort": 54290,
- "telHost": "mydomain.com",
- "telPort": 64195,
- "transport": "TCP",
- "authUserName": "sipconnectuser",
- "realm": "realm",
- "authenticationPasswordHashed": true,
- "sessionLimit": 10,
- "sessionLimitInbound": 10,
- "sessionLimitOutbound": 10,
- "sendProgressOnLoopDetected": true,
- "ignoreDeclineResponse": true,
- "forkingSupport": true,
- "sendOptionsPing": true,
- "federated": true,
- "disableSRTP": true,
- "mtlsAuthenticationOnInvite": true,
- "diversionIn": "NOT_SUPPORTED",
- "diversionOut": "NOT_SUPPORTED",
- "diversionMethod": "HISTORY_INFO_HEADER",
- "divertingCallingPartyRewrite": true,
- "destinationOutPhoneContext": "string",
- "callingPartyOutPhoneContext": "string",
- "defaultTrunk": true,
- "numberRange": [
- "string"
], - "publicNumberRangeStrings": [
- "string"
], - "privateNumberRangeStrings": [
- "string"
], - "transcode": true,
- "useScreenNumberAsBillingId": true,
- "filterCodecs": true,
- "codecs": {
- "codec": [
- {
- "payloadType": 0,
- "clockRate": 0,
- "encodingParameters": "string",
- "codecEnabled": true,
- "encodingName": "string"
}
]
}, - "trunkGroup": [
- "string"
], - "barringGroup": [
- "string"
], - "mexBypass": [
- "string"
], - "systemMexBypass": [
- "string"
], - "playPromptIfBarred": true,
- "organizationId": 4,
- "id": 0,
- "trustedDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "fromDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "mobileSubscriberDestinationLine": "ForwardCalledLine",
- "uniqueNumber": "ForwardCalledLine",
- "numberScreen": "REPLACE_WITH_DEFAULT_NUMBER",
- "numberScreenForDivertedCall": "REPLACE_WITH_DEFAULT_NUMBER",
- "allowUnHostedDiversionNumber": true,
- "treatPaiAsDiversion": "FROM_IS_NON_USER",
- "executeRulesOnDivertedCalls": true,
- "defaultScreenNumber": "+9633996633",
- "fallbackNumber": "46765964199",
- "fallbackTimeout": 3,
- "responseCodesTriggerCallForwarding": "400,403",
- "status": "PBX_STATUS_UP"
}Create trunk
This method is used to create an Enterprise SIP trunk.
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of Enterprise SIP trunk |
Request Body schema:
| deviceLocationName | string Device location will control how emergency calls are routed |
| name | string The name of the Enterprise SIP trunk that will be listed in the orgadmin interface |
| connectorType | string Enum: "SIP_CONNECT" "LYNC_2013" "SKYPE_FOR_BUSINESS_2015" "SKYPE_FOR_BUSINESS_2019" "REMOTE_GATEWAY" "STATIC_MODE_WITH_AUTHENTICATION" The type of the Enterprise SIP trunk |
| gateway | string Enum: "EDGE_NODE" "INTERCONNECT_NODE" Gateway to connect external telephony systems to communicate with remote systems |
| active | boolean Whether Enterprise SIP trunk is active or not |
| presenceHost | string Host for presence synchronization for Enterprise SIP trunks that connect to Lync/Skype for Business systems |
| presencePort | integer <int32> Port number for presence synchronization for Enterprise SIP trunks that connect to Lync/Skype for Business systems |
| telHost | string The host name to use when connecting for telephony calls |
| telPort | integer <int32> The port number to use when connecting for telephony calls |
| transport | string Enum: "TLS" "TCP" "UDP" Transport protocol |
| authUserName | string Authentication user name |
| realm | string Authentication/Authorization realm |
| authenticationPasswordHashed | boolean Whether authentication password hashed |
| sessionLimit | integer <int32> The maximum number of active incoming and outgoing sessions |
| sessionLimitInbound | integer <int32> The maximum number of active incoming sessions |
| sessionLimitOutbound | integer <int32> The maximum number of active outgoing sessions |
| sendProgressOnLoopDetected | boolean Send a progress message when loops are detected instead of rejecting a looped call to support an external voicemail |
| ignoreDeclineResponse | boolean Whether Ignore Decline responses should be rewritten to busy or not |
| forkingSupport | boolean Whether remote telephony system is responsible for forking calls to all targets that should ring for users |
| sendOptionsPing | boolean Send periodic SIP OPTIONS messages to monitor failing IP addresses in case of multiple IP addresses in DNS record |
| federated | boolean Whether the connector is federated, that is selectable in other organizations that are federated with (linked to) the organization that created the connector |
| disableSRTP | boolean Whether the audio should not be encrypted for phone calls with TLS signaling |
| mtlsAuthenticationOnInvite | boolean Use MTLS authentication for INVITE if digest authentication is only supported for registration, but no phone calls |
| diversionIn | string Enum: "NOT_SUPPORTED" "USE_CALLING_PARTY_REWRITE" "USE_DIVERSION_REWRITE" Diversion Method that will be used by in SIP signalling with the remote telephone system for incoming calls |
| diversionOut | string Enum: "NOT_SUPPORTED" "USE_CALLING_PARTY_REWRITE" "USE_DIVERSION_REWRITE" Diversion Method that will be used by in SIP signalling with the remote telephone system for outgoing calls |
| diversionMethod | string Enum: "NOT_SUPPORTED" "DIVERSION_HEADER" "HISTORY_INFO_HEADER" "REMOTE_PARTY_ID_HEADER" Diversion Method that will be used by in SIP signalling with the remote telephone system |
| divertingCallingPartyRewrite | boolean Whether the diversion rewrite use the calling party rewrite |
| destinationOutPhoneContext | string This phone context will be inserted for outgoing calls to numbers that are not in international format |
| callingPartyOutPhoneContext | string This phone context will be inserted for outgoing calls to numbers that are not in international format |
| defaultTrunk | boolean Whether you want to have private numbers, that do not have many other call routing defined in the organization, routed to the remote system |
| numberRange | Array of strings Handled by default Enterprise SIP trunk. Calls to numbers within these ranges, and that are not allocated to internal entities within the organization (e.g. users or function numbers), will break out on this Enterprise SIP trunk |
| publicNumberRangeStrings | Array of strings The range of public numbers that belong to the organization |
| privateNumberRangeStrings | Array of strings The range of private numbers that belong to the organization |
| transcode | boolean Transcode all voice streams for Enterprise SIP trunk. This is useful where the remote telephony system needs to communicate with other end-points, for example, SIP devices, that don't have any codecs in common |
| useScreenNumberAsBillingId | boolean Whether the screen number configured on the Enterprise SIP trunk to use as the billing ID for the Enterprise SIP trunk for calls originating from this Enterprise SIP trunk |
| filterCodecs | boolean The codecs supported by the Enterprise SIP trunk can be limited. This can be done to minimize bandwidth usage by allowing only low-bandwidth codecs |
object (Codecs) Available codecs | |
| trunkGroup | Array of strings A list of Enterprise SIP trunk groups |
| barringGroup | Array of strings A list of barring groups |
| mexBypass | Array of strings A list of service number groups for MEX bypass routing |
| systemMexBypass | Array of strings A list of service number groups for system MEX bypass routing |
| playPromptIfBarred | boolean Whether play prompt if call is barred |
| organizationId | integer <int32> The Id of the organization |
| id | integer <int64> The Id of the Enterprise SIP trunk that will be listed in the orgadmin interface |
Array of objects (LyncTrustedDomainDTO) The list of trusted domains | |
Array of objects (LyncFromDomainDTO) The list of domains Identifies Enterprise SIP trunk by the domain names in the From header field of the SIP request | |
| mobileSubscriberDestinationLine | string Enum: "PreferFixed" "Mobile" "ForwardCalledLine" "UNKNOWN" Configure which target type the remote telephony system prefers for incoming calls to Mobile Subscribers that are forwarded to the remote system |
| uniqueNumber | string Enterprise SIP trunk unique number |
| numberScreen | string Enum: "BLOCK" "REPLACE_WITH_DEFAULT_NUMBER" "REPLACE_WITH_DIVERSION_NUMBER" "ALLOW_ANY" "UNKNOWN" Number Screening for Non-diverted Calls specify how direct outbound calls whose calling number is out-of-range should be screened |
| numberScreenForDivertedCall | string Enum: "BLOCK" "REPLACE_WITH_DEFAULT_NUMBER" "REPLACE_WITH_DIVERSION_NUMBER" "ALLOW_ANY" "UNKNOWN" Number Screening for Diverted Calls specify how diverted outbound calls whose calling number is out-of-range should be screened |
| allowUnHostedDiversionNumber | boolean Allow unhosted diversion number to allow the diversion number to be out-of-range, or uncheck it to reject any diverted calls whose Diversion number is not within a number range of the organization |
| treatPaiAsDiversion | string Enum: "NEVER" "FROM_IS_OUT_OF_RANGE" "FROM_IS_NON_USER" "FROM_IS_NOT_SAME_USER" The P-Asserted-Identity (PAI) field is used to identify the caller |
| executeRulesOnDivertedCalls | boolean Whether apply outbound call routing rules for diverted calls to set number presentation or not |
| defaultScreenNumber | string Specify a default number for Enterprise SIP trunk |
| fallbackNumber | string Calls to the remote systems number ranges that fail with a xxx (or timeout) will be routed to this number |
| fallbackTimeout | integer <int32> The system triggers fallback or call forwarding on unreachable if no 18x response received before timeout reached. The maximum value of this setting is 3 minutes |
| responseCodesTriggerCallForwarding | string Comma-separated response codes that trigger call forwarding on unreachable for a user |
| status | string Enum: "PBX_STATUS_UP" "PBX_STATUS_DOWN_REGISTRATION_FAILURE" "PBX_STATUS_DOWN_CONNECTION_FAILURE" "PBX_STATUS_NOT_PROVIDED" "PBX_STATUS_TEMPORARILY_UNKNOWN" Enterprise SIP trunk status |
| authPassword | string Authentication password |
Responses
Request samples
- Payload
{- "deviceLocationName": "Default location",
- "name": "string",
- "connectorType": "SKYPE_FOR_BUSINESS_2019",
- "gateway": "INTERCONNECT_NODE",
- "active": true,
- "presenceHost": "test.com",
- "presencePort": 54290,
- "telHost": "mydomain.com",
- "telPort": 64195,
- "transport": "TCP",
- "authUserName": "sipconnectuser",
- "realm": "realm",
- "authenticationPasswordHashed": true,
- "sessionLimit": 10,
- "sessionLimitInbound": 10,
- "sessionLimitOutbound": 10,
- "sendProgressOnLoopDetected": true,
- "ignoreDeclineResponse": true,
- "forkingSupport": true,
- "sendOptionsPing": true,
- "federated": true,
- "disableSRTP": true,
- "mtlsAuthenticationOnInvite": true,
- "diversionIn": "NOT_SUPPORTED",
- "diversionOut": "NOT_SUPPORTED",
- "diversionMethod": "HISTORY_INFO_HEADER",
- "divertingCallingPartyRewrite": true,
- "destinationOutPhoneContext": "string",
- "callingPartyOutPhoneContext": "string",
- "defaultTrunk": true,
- "numberRange": [
- "string"
], - "publicNumberRangeStrings": [
- "string"
], - "privateNumberRangeStrings": [
- "string"
], - "transcode": true,
- "useScreenNumberAsBillingId": true,
- "filterCodecs": true,
- "codecs": {
- "codec": [
- {
- "payloadType": 0,
- "clockRate": 0,
- "encodingParameters": "string",
- "codecEnabled": true,
- "encodingName": "string"
}
]
}, - "trunkGroup": [
- "string"
], - "barringGroup": [
- "string"
], - "mexBypass": [
- "string"
], - "systemMexBypass": [
- "string"
], - "playPromptIfBarred": true,
- "organizationId": 4,
- "id": 0,
- "trustedDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "fromDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "mobileSubscriberDestinationLine": "ForwardCalledLine",
- "uniqueNumber": "ForwardCalledLine",
- "numberScreen": "REPLACE_WITH_DEFAULT_NUMBER",
- "numberScreenForDivertedCall": "REPLACE_WITH_DEFAULT_NUMBER",
- "allowUnHostedDiversionNumber": true,
- "treatPaiAsDiversion": "FROM_IS_NON_USER",
- "executeRulesOnDivertedCalls": true,
- "defaultScreenNumber": "+9633996633",
- "fallbackNumber": "46765964199",
- "fallbackTimeout": 3,
- "responseCodesTriggerCallForwarding": "400,403",
- "status": "PBX_STATUS_UP",
- "authPassword": "dk47FP4!b"
}List trunk rewrites
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
Responses
Response samples
- 200
{- "id": 0,
- "name": "string",
- "trunkName": "etrunk1",
- "trunkId": 1,
- "rewriteInfo": [
- {
- "id": 0,
- "description": "inbound rewrite for Etrunk_org4",
- "type": "CALLING_PARTY",
- "direction": "IN"
}
]
}Create trunk rewrite
Use this method to create rewrite for an existing Enterprise SIP trunk.
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
Request Body schema:
| direction required | string Direction of call, whether it is an inbound call or outbound call |
| type required | string Type of the rewrite rule |
| matchPrefix | string Indicates the number matching with prefix |
| matchSucceedingLength | integer <int32> Match succeeding length |
Array of objects (LyncConnectorRewriteRangeDTO) | |
| destinationTagsAsString | string |
| matchSuffix | string |
| mexbreakout | string |
| replacementSuffix | string |
| sourceTagsAsString | string |
| id | integer <int64> Id of the rewrite rule. |
| description | string Description for the rewrite rule |
| matchAnyPrefix | string Whether prefix matching required or not |
| matchEverywhere | string Character sequences need to be replaced other character sequences |
| matchMobileVPN | string Whether rewrite rule applied only to mobile originated calls or not |
| matchMEXOriginated | string Whether rewrite rule applied only to MEX originated calls or not |
| matchMobileTerminated | string Whether rewrite rule applied only to mobile terminated calls or not |
| MEXBreakout | string Indicates MEX mobile phone breakout |
| useOriginalShortNumber | string Whether the original number use as short number |
| anonymousCallingParty | string Whether the calling party is anonymous or not |
| matchRemaining | string Match against these digits after matching against prefix and 'followed by' |
| replacementEverywhere | string Replaces the value mentioned in the matchEverywhere property |
| replacementPrefix | string The value replaces the outbound/incoming call number prefix |
| replacementRemaining | string Replace the digits matched by 'Match remaining digits' |
| sourceTags | Array of strings A list of source tags |
| destinationTags | Array of strings A list of destination tags |
Array of objects (LyncConnectorRewriteRangeDTO) A list of match succeeding ranges |
Responses
Request samples
- Payload
{- "matchPrefix": "+91",
- "matchSucceedingLength": 3,
- "matchSucceedingRanges": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
], - "destinationTagsAsString": "string",
- "matchSuffix": "string",
- "mexbreakout": "string",
- "replacementSuffix": "string",
- "sourceTagsAsString": "string",
- "id": 1,
- "description": "inbound rewrite rule for Etrunk_org4",
- "direction": "IN",
- "type": "CALLING_PARTY",
- "matchAnyPrefix": "true",
- "matchEverywhere": "44,32",
- "matchMobileVPN": "true",
- "matchMEXOriginated": "true",
- "matchMobileTerminated": "true",
- "MEXBreakout": "true",
- "useOriginalShortNumber": "true",
- "anonymousCallingParty": "true",
- "matchRemaining": "44",
- "replacementEverywhere": "20",
- "replacementPrefix": "+46",
- "replacementRemaining": "+46",
- "sourceTags": [
- "string"
], - "destinationTags": [
- "string"
], - "range": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Update call admission control
Use this API to update the call admission control for an organization.
path Parameters
| domain required | string |
Request Body schema:
| orgId | integer <int32> |
| sessionLimit | integer <int32> |
| sessionLimitInbound | integer <int32> |
| sessionLimitOutbound | integer <int32> |
| transcodingSessionLimit | integer <int32> |
| etrunkId | integer <int64> |
Responses
Request samples
- Payload
Response samples
- 200
Get trunk rewrite
Use this method to retrieve rewrites of an Enterprise SIP Trunk.
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
| rewriteId required | string The id of rewrite |
Responses
Response samples
- 200
{- "matchPrefix": "+91",
- "matchSucceedingLength": 3,
- "matchSucceedingRanges": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
], - "destinationTagsAsString": "string",
- "matchSuffix": "string",
- "mexbreakout": "string",
- "replacementSuffix": "string",
- "sourceTagsAsString": "string",
- "id": 1,
- "description": "inbound rewrite rule for Etrunk_org4",
- "direction": "IN",
- "type": "CALLING_PARTY",
- "matchAnyPrefix": "true",
- "matchEverywhere": "44,32",
- "matchMobileVPN": "true",
- "matchMEXOriginated": "true",
- "matchMobileTerminated": "true",
- "MEXBreakout": "true",
- "useOriginalShortNumber": "true",
- "anonymousCallingParty": "true",
- "matchRemaining": "44",
- "replacementEverywhere": "20",
- "replacementPrefix": "+46",
- "replacementRemaining": "+46",
- "sourceTags": [
- "string"
], - "destinationTags": [
- "string"
], - "range": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
]
}Update trunk rewrite
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
| rewriteId required | integer <int64> The id of rewrite |
Request Body schema:
| direction required | string Direction of call, whether it is an inbound call or outbound call |
| type required | string Type of the rewrite rule |
| matchPrefix | string Indicates the number matching with prefix |
| matchSucceedingLength | integer <int32> Match succeeding length |
Array of objects (LyncConnectorRewriteRangeDTO) | |
| destinationTagsAsString | string |
| matchSuffix | string |
| mexbreakout | string |
| replacementSuffix | string |
| sourceTagsAsString | string |
| id | integer <int64> Id of the rewrite rule. |
| description | string Description for the rewrite rule |
| matchAnyPrefix | string Whether prefix matching required or not |
| matchEverywhere | string Character sequences need to be replaced other character sequences |
| matchMobileVPN | string Whether rewrite rule applied only to mobile originated calls or not |
| matchMEXOriginated | string Whether rewrite rule applied only to MEX originated calls or not |
| matchMobileTerminated | string Whether rewrite rule applied only to mobile terminated calls or not |
| MEXBreakout | string Indicates MEX mobile phone breakout |
| useOriginalShortNumber | string Whether the original number use as short number |
| anonymousCallingParty | string Whether the calling party is anonymous or not |
| matchRemaining | string Match against these digits after matching against prefix and 'followed by' |
| replacementEverywhere | string Replaces the value mentioned in the matchEverywhere property |
| replacementPrefix | string The value replaces the outbound/incoming call number prefix |
| replacementRemaining | string Replace the digits matched by 'Match remaining digits' |
| sourceTags | Array of strings A list of source tags |
| destinationTags | Array of strings A list of destination tags |
Array of objects (LyncConnectorRewriteRangeDTO) A list of match succeeding ranges |
Responses
Request samples
- Payload
{- "matchPrefix": "+91",
- "matchSucceedingLength": 3,
- "matchSucceedingRanges": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
], - "destinationTagsAsString": "string",
- "matchSuffix": "string",
- "mexbreakout": "string",
- "replacementSuffix": "string",
- "sourceTagsAsString": "string",
- "id": 1,
- "description": "inbound rewrite rule for Etrunk_org4",
- "direction": "IN",
- "type": "CALLING_PARTY",
- "matchAnyPrefix": "true",
- "matchEverywhere": "44,32",
- "matchMobileVPN": "true",
- "matchMEXOriginated": "true",
- "matchMobileTerminated": "true",
- "MEXBreakout": "true",
- "useOriginalShortNumber": "true",
- "anonymousCallingParty": "true",
- "matchRemaining": "44",
- "replacementEverywhere": "20",
- "replacementPrefix": "+46",
- "replacementRemaining": "+46",
- "sourceTags": [
- "string"
], - "destinationTags": [
- "string"
], - "range": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
]
}Get trunk status
Read Enterprise SIP trunk status
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
Responses
Response samples
- 200
{- "matchPrefix": "+91",
- "matchSucceedingLength": 3,
- "matchSucceedingRanges": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
], - "destinationTagsAsString": "string",
- "matchSuffix": "string",
- "mexbreakout": "string",
- "replacementSuffix": "string",
- "sourceTagsAsString": "string",
- "id": 1,
- "description": "inbound rewrite rule for Etrunk_org4",
- "direction": "IN",
- "type": "CALLING_PARTY",
- "matchAnyPrefix": "true",
- "matchEverywhere": "44,32",
- "matchMobileVPN": "true",
- "matchMEXOriginated": "true",
- "matchMobileTerminated": "true",
- "MEXBreakout": "true",
- "useOriginalShortNumber": "true",
- "anonymousCallingParty": "true",
- "matchRemaining": "44",
- "replacementEverywhere": "20",
- "replacementPrefix": "+46",
- "replacementRemaining": "+46",
- "sourceTags": [
- "string"
], - "destinationTags": [
- "string"
], - "range": [
- {
- "id": 0,
- "start": 22,
- "stop": 99
}
]
}List trunks
Read Enterprise SIP trunks
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "enterpriseTrunk": [
- {
- "deviceLocationName": "Default location",
- "name": "string",
- "connectorType": "SKYPE_FOR_BUSINESS_2019",
- "gateway": "INTERCONNECT_NODE",
- "active": true,
- "presenceHost": "test.com",
- "presencePort": 54290,
- "telHost": "mydomain.com",
- "telPort": 64195,
- "transport": "TCP",
- "authUserName": "sipconnectuser",
- "realm": "realm",
- "authenticationPasswordHashed": true,
- "sessionLimit": 10,
- "sessionLimitInbound": 10,
- "sessionLimitOutbound": 10,
- "sendProgressOnLoopDetected": true,
- "ignoreDeclineResponse": true,
- "forkingSupport": true,
- "sendOptionsPing": true,
- "federated": true,
- "disableSRTP": true,
- "mtlsAuthenticationOnInvite": true,
- "diversionIn": "NOT_SUPPORTED",
- "diversionOut": "NOT_SUPPORTED",
- "diversionMethod": "HISTORY_INFO_HEADER",
- "divertingCallingPartyRewrite": true,
- "destinationOutPhoneContext": "string",
- "callingPartyOutPhoneContext": "string",
- "defaultTrunk": true,
- "numberRange": [
- "string"
], - "publicNumberRangeStrings": [
- "string"
], - "privateNumberRangeStrings": [
- "string"
], - "transcode": true,
- "useScreenNumberAsBillingId": true,
- "filterCodecs": true,
- "codecs": {
- "codec": [
- {
- "payloadType": 0,
- "clockRate": 0,
- "encodingParameters": "string",
- "codecEnabled": true,
- "encodingName": "string"
}
]
}, - "trunkGroup": [
- "string"
], - "barringGroup": [
- "string"
], - "mexBypass": [
- "string"
], - "systemMexBypass": [
- "string"
], - "playPromptIfBarred": true,
- "organizationId": 4,
- "id": 0,
- "trustedDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "fromDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "mobileSubscriberDestinationLine": "ForwardCalledLine",
- "uniqueNumber": "ForwardCalledLine",
- "numberScreen": "REPLACE_WITH_DEFAULT_NUMBER",
- "numberScreenForDivertedCall": "REPLACE_WITH_DEFAULT_NUMBER",
- "allowUnHostedDiversionNumber": true,
- "treatPaiAsDiversion": "FROM_IS_NON_USER",
- "executeRulesOnDivertedCalls": true,
- "defaultScreenNumber": "+9633996633",
- "fallbackNumber": "46765964199",
- "fallbackTimeout": 3,
- "responseCodesTriggerCallForwarding": "400,403",
- "status": "PBX_STATUS_UP"
}
]
}Update trunk
Use this method to update an existing Enterprise SIP trunk.
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The id of Enterprise SIP trunk |
Request Body schema:
| deviceLocationName | string Device location will control how emergency calls are routed |
| name | string The name of the Enterprise SIP trunk that will be listed in the orgadmin interface |
| connectorType | string Enum: "SIP_CONNECT" "LYNC_2013" "SKYPE_FOR_BUSINESS_2015" "SKYPE_FOR_BUSINESS_2019" "REMOTE_GATEWAY" "STATIC_MODE_WITH_AUTHENTICATION" The type of the Enterprise SIP trunk |
| gateway | string Enum: "EDGE_NODE" "INTERCONNECT_NODE" Gateway to connect external telephony systems to communicate with remote systems |
| active | boolean Whether Enterprise SIP trunk is active or not |
| presenceHost | string Host for presence synchronization for Enterprise SIP trunks that connect to Lync/Skype for Business systems |
| presencePort | integer <int32> Port number for presence synchronization for Enterprise SIP trunks that connect to Lync/Skype for Business systems |
| telHost | string The host name to use when connecting for telephony calls |
| telPort | integer <int32> The port number to use when connecting for telephony calls |
| transport | string Enum: "TLS" "TCP" "UDP" Transport protocol |
| authUserName | string Authentication user name |
| realm | string Authentication/Authorization realm |
| authenticationPasswordHashed | boolean Whether authentication password hashed |
| sessionLimit | integer <int32> The maximum number of active incoming and outgoing sessions |
| sessionLimitInbound | integer <int32> The maximum number of active incoming sessions |
| sessionLimitOutbound | integer <int32> The maximum number of active outgoing sessions |
| sendProgressOnLoopDetected | boolean Send a progress message when loops are detected instead of rejecting a looped call to support an external voicemail |
| ignoreDeclineResponse | boolean Whether Ignore Decline responses should be rewritten to busy or not |
| forkingSupport | boolean Whether remote telephony system is responsible for forking calls to all targets that should ring for users |
| sendOptionsPing | boolean Send periodic SIP OPTIONS messages to monitor failing IP addresses in case of multiple IP addresses in DNS record |
| federated | boolean Whether the connector is federated, that is selectable in other organizations that are federated with (linked to) the organization that created the connector |
| disableSRTP | boolean Whether the audio should not be encrypted for phone calls with TLS signaling |
| mtlsAuthenticationOnInvite | boolean Use MTLS authentication for INVITE if digest authentication is only supported for registration, but no phone calls |
| diversionIn | string Enum: "NOT_SUPPORTED" "USE_CALLING_PARTY_REWRITE" "USE_DIVERSION_REWRITE" Diversion Method that will be used by in SIP signalling with the remote telephone system for incoming calls |
| diversionOut | string Enum: "NOT_SUPPORTED" "USE_CALLING_PARTY_REWRITE" "USE_DIVERSION_REWRITE" Diversion Method that will be used by in SIP signalling with the remote telephone system for outgoing calls |
| diversionMethod | string Enum: "NOT_SUPPORTED" "DIVERSION_HEADER" "HISTORY_INFO_HEADER" "REMOTE_PARTY_ID_HEADER" Diversion Method that will be used by in SIP signalling with the remote telephone system |
| divertingCallingPartyRewrite | boolean Whether the diversion rewrite use the calling party rewrite |
| destinationOutPhoneContext | string This phone context will be inserted for outgoing calls to numbers that are not in international format |
| callingPartyOutPhoneContext | string This phone context will be inserted for outgoing calls to numbers that are not in international format |
| defaultTrunk | boolean Whether you want to have private numbers, that do not have many other call routing defined in the organization, routed to the remote system |
| numberRange | Array of strings Handled by default Enterprise SIP trunk. Calls to numbers within these ranges, and that are not allocated to internal entities within the organization (e.g. users or function numbers), will break out on this Enterprise SIP trunk |
| publicNumberRangeStrings | Array of strings The range of public numbers that belong to the organization |
| privateNumberRangeStrings | Array of strings The range of private numbers that belong to the organization |
| transcode | boolean Transcode all voice streams for Enterprise SIP trunk. This is useful where the remote telephony system needs to communicate with other end-points, for example, SIP devices, that don't have any codecs in common |
| useScreenNumberAsBillingId | boolean Whether the screen number configured on the Enterprise SIP trunk to use as the billing ID for the Enterprise SIP trunk for calls originating from this Enterprise SIP trunk |
| filterCodecs | boolean The codecs supported by the Enterprise SIP trunk can be limited. This can be done to minimize bandwidth usage by allowing only low-bandwidth codecs |
object (Codecs) Available codecs | |
| trunkGroup | Array of strings A list of Enterprise SIP trunk groups |
| barringGroup | Array of strings A list of barring groups |
| mexBypass | Array of strings A list of service number groups for MEX bypass routing |
| systemMexBypass | Array of strings A list of service number groups for system MEX bypass routing |
| playPromptIfBarred | boolean Whether play prompt if call is barred |
| organizationId | integer <int32> The Id of the organization |
| id | integer <int64> The Id of the Enterprise SIP trunk that will be listed in the orgadmin interface |
Array of objects (LyncTrustedDomainDTO) The list of trusted domains | |
Array of objects (LyncFromDomainDTO) The list of domains Identifies Enterprise SIP trunk by the domain names in the From header field of the SIP request | |
| mobileSubscriberDestinationLine | string Enum: "PreferFixed" "Mobile" "ForwardCalledLine" "UNKNOWN" Configure which target type the remote telephony system prefers for incoming calls to Mobile Subscribers that are forwarded to the remote system |
| uniqueNumber | string Enterprise SIP trunk unique number |
| numberScreen | string Enum: "BLOCK" "REPLACE_WITH_DEFAULT_NUMBER" "REPLACE_WITH_DIVERSION_NUMBER" "ALLOW_ANY" "UNKNOWN" Number Screening for Non-diverted Calls specify how direct outbound calls whose calling number is out-of-range should be screened |
| numberScreenForDivertedCall | string Enum: "BLOCK" "REPLACE_WITH_DEFAULT_NUMBER" "REPLACE_WITH_DIVERSION_NUMBER" "ALLOW_ANY" "UNKNOWN" Number Screening for Diverted Calls specify how diverted outbound calls whose calling number is out-of-range should be screened |
| allowUnHostedDiversionNumber | boolean Allow unhosted diversion number to allow the diversion number to be out-of-range, or uncheck it to reject any diverted calls whose Diversion number is not within a number range of the organization |
| treatPaiAsDiversion | string Enum: "NEVER" "FROM_IS_OUT_OF_RANGE" "FROM_IS_NON_USER" "FROM_IS_NOT_SAME_USER" The P-Asserted-Identity (PAI) field is used to identify the caller |
| executeRulesOnDivertedCalls | boolean Whether apply outbound call routing rules for diverted calls to set number presentation or not |
| defaultScreenNumber | string Specify a default number for Enterprise SIP trunk |
| fallbackNumber | string Calls to the remote systems number ranges that fail with a xxx (or timeout) will be routed to this number |
| fallbackTimeout | integer <int32> The system triggers fallback or call forwarding on unreachable if no 18x response received before timeout reached. The maximum value of this setting is 3 minutes |
| responseCodesTriggerCallForwarding | string Comma-separated response codes that trigger call forwarding on unreachable for a user |
| status | string Enum: "PBX_STATUS_UP" "PBX_STATUS_DOWN_REGISTRATION_FAILURE" "PBX_STATUS_DOWN_CONNECTION_FAILURE" "PBX_STATUS_NOT_PROVIDED" "PBX_STATUS_TEMPORARILY_UNKNOWN" Enterprise SIP trunk status |
| authPassword | string Authentication password |
Responses
Request samples
- Payload
{- "deviceLocationName": "Default location",
- "name": "string",
- "connectorType": "SKYPE_FOR_BUSINESS_2019",
- "gateway": "INTERCONNECT_NODE",
- "active": true,
- "presenceHost": "test.com",
- "presencePort": 54290,
- "telHost": "mydomain.com",
- "telPort": 64195,
- "transport": "TCP",
- "authUserName": "sipconnectuser",
- "realm": "realm",
- "authenticationPasswordHashed": true,
- "sessionLimit": 10,
- "sessionLimitInbound": 10,
- "sessionLimitOutbound": 10,
- "sendProgressOnLoopDetected": true,
- "ignoreDeclineResponse": true,
- "forkingSupport": true,
- "sendOptionsPing": true,
- "federated": true,
- "disableSRTP": true,
- "mtlsAuthenticationOnInvite": true,
- "diversionIn": "NOT_SUPPORTED",
- "diversionOut": "NOT_SUPPORTED",
- "diversionMethod": "HISTORY_INFO_HEADER",
- "divertingCallingPartyRewrite": true,
- "destinationOutPhoneContext": "string",
- "callingPartyOutPhoneContext": "string",
- "defaultTrunk": true,
- "numberRange": [
- "string"
], - "publicNumberRangeStrings": [
- "string"
], - "privateNumberRangeStrings": [
- "string"
], - "transcode": true,
- "useScreenNumberAsBillingId": true,
- "filterCodecs": true,
- "codecs": {
- "codec": [
- {
- "payloadType": 0,
- "clockRate": 0,
- "encodingParameters": "string",
- "codecEnabled": true,
- "encodingName": "string"
}
]
}, - "trunkGroup": [
- "string"
], - "barringGroup": [
- "string"
], - "mexBypass": [
- "string"
], - "systemMexBypass": [
- "string"
], - "playPromptIfBarred": true,
- "organizationId": 4,
- "id": 0,
- "trustedDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "fromDomain": [
- {
- "domain": "test.com",
- "organizationId": 4
}
], - "mobileSubscriberDestinationLine": "ForwardCalledLine",
- "uniqueNumber": "ForwardCalledLine",
- "numberScreen": "REPLACE_WITH_DEFAULT_NUMBER",
- "numberScreenForDivertedCall": "REPLACE_WITH_DEFAULT_NUMBER",
- "allowUnHostedDiversionNumber": true,
- "treatPaiAsDiversion": "FROM_IS_NON_USER",
- "executeRulesOnDivertedCalls": true,
- "defaultScreenNumber": "+9633996633",
- "fallbackNumber": "46765964199",
- "fallbackTimeout": 3,
- "responseCodesTriggerCallForwarding": "400,403",
- "status": "PBX_STATUS_UP",
- "authPassword": "dk47FP4!b"
}The External Telephony System Integration API is used to configure External Telephony System integration policies for organizations or groups.
Use the External Telephony System Integration API to:
- Create integration policy for organization
- Get integration policy for organization
- Get integration policy for user group
- List available activities for organization
- List external presence states
- Update integration policy
- Delete integration policy
Get integration policy
Fetch policy for External Telephony System integration defined for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch integration policy |
Responses
Response samples
- 200
{- "id": 2,
- "etrunkId": 2,
- "ownerType": "ORGANIZATION",
- "showLineState": true,
- "enableMex": false,
- "lyncPresenceMapping": [
- {
- "type": "away",
- "activity": "out_of_office",
- "priorityOrder": 2
}, - {
- "type": "away",
- "activity": "1589791817185",
- "priorityOrder": 3
}, - {
- "type": "do_not_disturb",
- "activity": "busy",
- "priorityOrder": 1
}
]
}Update integration policy
Update an External Telephony System integration policy for an organization or user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization in which the integration policy is defined |
Request Body schema: required
| id | integer <int64> The integration policy id. Not to be included in create requests. |
| etrunkId | integer <int64> The id of the Enterprise SIP trunk appointed by the integration policy |
| ownerId | string The name of the user group that owns the policy, or empty if ownerType is ORGANIZATION |
| ownerType | string Enum: "USE_RESOLVER" "SYSTEM" "ORGANIZATION" "GROUP" "USER" "FUNCTION_NUMBER" "LINKED_ORGANIZATION" "LINKED_ORGANIZATION_GROUP" The owner type, applicable values are ORGANIZATION and GROUP |
| showLineState | boolean Whether or not line states are synchronized with the remote system |
| enableMex | boolean Whether or not this policy enables Mobile Extension routing |
Array of objects (LyncPresenceMappingDTO) Mapping of a Lync presence state and an activity |
Responses
Request samples
- Payload
{- "id": 1,
- "etrunkId": 2,
- "ownerId": "userGroup1",
- "ownerType": "GROUP",
- "showLineState": true,
- "enableMex": false,
- "lyncPresenceMapping": [
- {
- "type": "away",
- "activity": "out_of_office",
- "priorityOrder": 2
}, - {
- "type": "away",
- "activity": "1589791817185",
- "priorityOrder": 3
}, - {
- "type": "do_not_disturb",
- "activity": "busy",
- "priorityOrder": 1
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create integration policy
Create an External Telephony System integration policy for an organization or user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization in which the integration policy should be created |
Request Body schema: required
| id | integer <int64> The integration policy id. Not to be included in create requests. |
| etrunkId | integer <int64> The id of the Enterprise SIP trunk appointed by the integration policy |
| ownerId | string The name of the user group that owns the policy, or empty if ownerType is ORGANIZATION |
| ownerType | string Enum: "USE_RESOLVER" "SYSTEM" "ORGANIZATION" "GROUP" "USER" "FUNCTION_NUMBER" "LINKED_ORGANIZATION" "LINKED_ORGANIZATION_GROUP" The owner type, applicable values are ORGANIZATION and GROUP |
| showLineState | boolean Whether or not line states are synchronized with the remote system |
| enableMex | boolean Whether or not this policy enables Mobile Extension routing |
Array of objects (LyncPresenceMappingDTO) Mapping of a Lync presence state and an activity |
Responses
Request samples
- Payload
{- "etrunkId": 2,
- "ownerType": "ORGANIZATION",
- "showLineState": true,
- "enableMex": false,
- "lyncPresenceMapping": [
- {
- "type": "away",
- "activity": "out_of_office",
- "priorityOrder": 2
}, - {
- "type": "away",
- "activity": "1589791817185",
- "priorityOrder": 3
}, - {
- "type": "do_not_disturb",
- "activity": "busy",
- "priorityOrder": 1
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get integration policy, group
Retrieve policy for External Telephony System integration defined for a user group in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch External Telephony System integration policy |
| group required | string The user group in the organization for which to fetch External Telephony System integration policy |
Responses
Response samples
- 200
{- "id": 1,
- "etrunkId": 2,
- "ownerId": "userGroup1",
- "ownerType": "GROUP",
- "showLineState": true,
- "enableMex": false,
- "lyncPresenceMapping": [
- {
- "type": "away",
- "activity": "out_of_office",
- "priorityOrder": 2
}, - {
- "type": "away",
- "activity": "1589791817185",
- "priorityOrder": 3
}, - {
- "type": "do_not_disturb",
- "activity": "busy",
- "priorityOrder": 1
}
]
}List external presence states
Fetch available Lync/Skype for Business presence states for an organization. These states can be used to configure presence synchronization policies.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch available Lync presence states |
Responses
Response samples
- 200
{- "lyncPresenceState": [
- "offline",
- "online",
- "away",
- "busy",
- "do_not_disturb"
]
}List activities
Fetch available activities for an organization. These activities can be used to configure presence synchronization policies.
Authorizations:
path Parameters
| domain required | string The domain of the organization for which to fetch available activities |
Responses
Response samples
- 200
{- "activity": [
- {
- "id": "available",
- "name": "Available",
- "available": true,
- "stateName": "Available"
}, - {
- "id": "busy",
- "name": "Busy",
- "available": false,
- "stateName": "Busy"
}, - {
- "id": "meeting",
- "name": "Meeting",
- "available": false,
- "stateName": "Meeting"
}, - {
- "id": "out_of_office",
- "name": "Out of Office",
- "available": false,
- "stateName": "Out of Office"
}, - {
- "id": "lunch",
- "name": "Lunch",
- "available": false,
- "stateName": "Lunch"
}, - {
- "id": "vacation",
- "name": "Vacation",
- "available": false,
- "stateName": "Vacation"
}, - {
- "id": "1589816257250",
- "name": "Coffee Break",
- "available": true,
- "stateName": "Coffee Break"
}
]
}The Routing Tags API is a group of methods to manage routing tags which are used to control end-users call routing rules.
Use the Routing Tags API to:
- Add routing tag for a user
- List routing tags for a user
- Delete routing tag for a user
Get routing tags
Retrieve all available routing tags for a user
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
| userId required | string The user ID without domain suffix. |
Responses
Response samples
- 200
- 403
- 404
{- "tag": [
- "routingtag1",
- "routingtag2"
]
}The Service Number Groups API is a group of methods to manage service number groups for an organization.
Use the Service Number Groups API to:
- Get system service number groups for an organization
- Get a system service number group for an organization
- Get a service number group for an organization
- Get service number groups for an organization
- Create a service number group for an organization
- Update a service number group for an organization
- Delete a service number group for an organization
Get Service number groups
Read organization service number groups.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "serviceNumberGroup": [
- {
- "name": "service_group1",
- "serviceNumber": [
- {
- "number": "+468",
- "prefix": true
}
], - "organizationId": 404
}
]
}Create Service number group
Create an organization service number group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| name | string Name of the service number group |
Array of objects (serviceNumber) List of service numbers | |
| organizationId | integer <int32> Id of the organization |
Responses
Request samples
- Payload
{- "name": "service_group1",
- "serviceNumber": [
- {
- "number": "+468",
- "prefix": true
}
], - "organizationId": 404
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get Service number group
Read a specific organization service number group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the service number group |
Responses
Response samples
- 200
{- "name": "service_group1",
- "serviceNumber": [
- {
- "number": "+468",
- "prefix": true
}
], - "organizationId": 404
}Update Service number group
Update an organization service number group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the service number group |
Request Body schema: */*
| name | string Name of the service number group |
Array of objects (serviceNumber) List of service numbers | |
| organizationId | integer <int32> Id of the organization |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete Service number group
Delete an organization service number group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the service number group |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get system Service number group
Read a specific system service number group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| name required | string The name of the system service number groups |
Responses
Response samples
- 200
{- "name": "group1",
- "serviceNumber": [
- {
- "number": "+468",
- "prefix": true
}
], - "resellerName": "default"
}Get system Service number groups
Read system service number groups.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "systemServiceNumberGroup": [
- {
- "name": "group1",
- "serviceNumber": [
- {
- "number": "+468",
- "prefix": true
}
], - "resellerName": "default"
}
]
}The Trunk Tags API is a group of methods to manage trunk tags which are used by external systems, and determine call routing order, prior to when other call routing rules apply.
Use the Trunk Tags API to:
- Add trunk tag for a user
- Update existing trunk tag for a user
- List trunk tags for a user
- Delete trunk tag for a user
The UC Analytics API is a group of methods to manage UC Analytics settings for an organization
Use the UC Analytics API to:
- Get UC analytics settings
- Update UC analytics settings
- Create UC analytics settings
Get settings
Read organization UC analytics settings.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "businessAnalyticsType": "INSIGHT",
- "businessAnalyticsRecording": true,
- "digitsToMask": 0,
- "maskInternalCalls": true,
- "maskIncomingExternalCalls": true,
- "maskOutgoingExternalCalls": true,
- "storagePeriod": "UNLIMITED",
- "ucAnalyticsType": "NONE"
}Update settings
Update UC analytics setting for an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| ucAnalyticsType required | string Enum: "NONE" "RECORDING" "ADVANCED" "BUSINESS" An enum representing the UC Analytics type for the organization. |
| businessAnalyticsType | string Enum: "INSIGHT" "REPORT" "ACDREPORT" An enum representing the Business Analytics type for the organization. Mandatory if ucAnalyticsType == BUSINESS |
| businessAnalyticsRecording | boolean A boolean value specifying if call recording is used in conjuction with Busniess Analytics for the organization. |
| digitsToMask | integer <int32> Represents the number of digits to mask. |
| maskInternalCalls | boolean Whether phone number masking is applicable for internal calls. |
| maskIncomingExternalCalls | boolean Whether phone number masking is applicable for incoming external calls. |
| maskOutgoingExternalCalls | boolean Whether phone number masking is applicable for outgoing external calls. |
| storagePeriod | string Enum: "UNLIMITED" "_1_MONTH" "_3_MONTHS" "_6_MONTHS" "_1_YEAR" "_18_MONTHS" "_2_YEARS" "_3_YEARS" "_4_YEARS" "_5_YEARS" "_6_YEARS" "_7_YEARS" An enum representing how long call recordings are saved. |
Responses
Request samples
- Payload
{- "businessAnalyticsType": "INSIGHT",
- "businessAnalyticsRecording": true,
- "digitsToMask": 0,
- "maskInternalCalls": true,
- "maskIncomingExternalCalls": true,
- "maskOutgoingExternalCalls": true,
- "storagePeriod": "UNLIMITED",
- "ucAnalyticsType": "NONE"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create settings
Create UC analytics setting for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| ucAnalyticsType required | string Enum: "NONE" "RECORDING" "ADVANCED" "BUSINESS" An enum representing the UC Analytics type for the organization. |
| businessAnalyticsType | string Enum: "INSIGHT" "REPORT" "ACDREPORT" An enum representing the Business Analytics type for the organization. Mandatory if ucAnalyticsType == BUSINESS |
| businessAnalyticsRecording | boolean A boolean value specifying if call recording is used in conjuction with Busniess Analytics for the organization. |
| digitsToMask | integer <int32> Represents the number of digits to mask. |
| maskInternalCalls | boolean Whether phone number masking is applicable for internal calls. |
| maskIncomingExternalCalls | boolean Whether phone number masking is applicable for incoming external calls. |
| maskOutgoingExternalCalls | boolean Whether phone number masking is applicable for outgoing external calls. |
| storagePeriod | string Enum: "UNLIMITED" "_1_MONTH" "_3_MONTHS" "_6_MONTHS" "_1_YEAR" "_18_MONTHS" "_2_YEARS" "_3_YEARS" "_4_YEARS" "_5_YEARS" "_6_YEARS" "_7_YEARS" An enum representing how long call recordings are saved. |
Responses
Request samples
- Payload
{- "businessAnalyticsType": "INSIGHT",
- "businessAnalyticsRecording": true,
- "digitsToMask": 0,
- "maskInternalCalls": true,
- "maskIncomingExternalCalls": true,
- "maskOutgoingExternalCalls": true,
- "storagePeriod": "UNLIMITED",
- "ucAnalyticsType": "NONE"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Available Number API is a group of methods to get available numbers of different types from the number ranges for an organization.
Use the Available Number API to:
- Get available numbers for an organization
- Get available mobile numbers for an organization
- Get available public numbers for an organization
- Get available private numbers for an organization
Get all available mobile numbers
All non-occupied mobile numbers in the organization's mobile number pool are returned.
Authorizations:
path Parameters
| domain required | string The organization domain |
query Parameters
| ignoreNoSourceTags | boolean Ignore numbers in ranges without any assigned source tags. |
Responses
Response samples
- 200
{- "number": [
- "+46815170",
- "+46815191",
- "+46815200"
]
}Get all available numbers
All non-occupied numbers in the organization's number ranges.
Authorizations:
path Parameters
| domain required | string The organization domain |
query Parameters
| ignoreNoSourceTags | boolean Ignore numbers in ranges without any assigned source tags. |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994",
- "501",
- "511"
]
}Get all available private numbers
All non-occupied private numbers in the organization's number ranges are returned.
Authorizations:
path Parameters
| domain required | string The organization domain |
query Parameters
| ignoreNoSourceTags | boolean Ignore numbers in ranges without any assigned source tags. |
Responses
Response samples
- 200
{- "number": [
- "501",
- "511"
]
}Get all available public numbers
All non-occupied public numbers in the organization's number ranges are returned.
Authorizations:
path Parameters
| domain required | string The organization domain |
query Parameters
| ignoreNoSourceTags | boolean Ignore numbers in ranges without any assigned source tags. |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994"
]
}Get available mobile numbers
Non-occupied mobile numbers in the organization's mobile number pool are returned.
When retrieving available mobile numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+46815170",
- "+46815191",
- "+46815200"
]
}Get available mobile numbers Deprecated
Non-occupied mobile numbers in the organization's mobile number pool are returned.
When retrieving available mobile numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+46815170",
- "+46815191",
- "+46815200"
]
}Get available numbers
Non-occupied numbers in the organization's number ranges are returned.
When retrieving available numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994",
- "501",
- "511"
]
}Get available numbers Deprecated
Non-occupied numbers in the organization's number ranges are returned.
When retrieving available numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994",
- "501",
- "511"
]
}Get available private numbers
Non-occupied private numbers in the organization's number ranges are returned.
When retrieving available private numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "501",
- "511"
]
}Get available private numbers Deprecated
Non-occupied private numbers in the organization's number ranges are returned.
When retrieving available private numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "501",
- "511"
]
}Get available public numbers
Non-occupied public numbers in the organization's number ranges are returned.
When retrieving available public numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994"
]
}Get available public numbers Deprecated
Non-occupied public numbers in the organization's number ranges are returned.
When retrieving available public numbers, a maximum of 100 results are shown, divided evenly between the organization's number ranges. For example, if having 5 different ranges, 20 numbers per range will be fetched.
NOTE: This method is DEPRECATED since 5.4 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "number": [
- "+0022200",
- "+0202217",
- "+46840837990",
- "+46840837994"
]
}The Barring Group API is a group of methods to manage barring groups for an organization.
Use the Barring Group API to:
- Create a barring group
- Get all barring groups
- Get a barring group
- Get users in a barring group
- Get function numbers in a barring group
- Update a barring group
- Delete a barring group
Update barring group
Update an existing barring group.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
| groupName required | string The name of the barring group |
Request Body schema:
| name | string Name of the barring group. |
Array of objects (User) User members of the group. | |
Array of objects (FunctionNumber) Function number members of the group. |
Responses
Request samples
- Payload
{- "name": "Barring"
}Create barring group
Create a barring group in an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
| groupName required | string The name of the barring group |
Request Body schema:
| name | string Name of the barring group. |
Array of objects (User) User members of the group. | |
Array of objects (FunctionNumber) Function number members of the group. |
Responses
Request samples
- Payload
{- "name": "Barring"
}Get function numbers in barring group
Fetch the function numbers in a barring group.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
| groupName required | string The name of the barring group |
Responses
Response samples
- 200
{- "name": "Barring",
- "functionNumber": [
- {
- "number": "+46812345003",
- "type": "CONFERENCE"
}, - {
- "name": "ACD_GROUP1",
- "number": "+46812345004",
- "type": "ACD"
}
]
}List barring group users
Fetch the list of users in a specified barrring group.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
| groupName required | string The name of the barring group |
Responses
Response samples
- 200
{- "name": "Barring",
- "user": [
- {
- "name": "John Doe",
- "userId": "john",
- "primaryNumber": "+46812345001"
}, - {
- "name": "Jane Smith",
- "userId": "jane",
- "primaryNumber": "+46812345002"
}
]
}The Directory Field API is a group of methods to manage directory fields for an organization
Use the Directory Field API to:
- Get directory field types
- Get directory fields
- Get localized directory fields
- Get directory limits
- Update directory fields
- Update localized directory fields
Update directory fields
Update directory fields
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
Array of objects (DirectoryFieldDTO) List of directory fields |
Responses
Request samples
- Payload
{- "directoryField": [
- {
- "id": "field7",
- "label": "Manager",
- "editable": true,
- "typeId": 1,
- "searchable": true
}
]
}List directory limits
Read all directory limits
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "localizedDirectoryFieldLimit": [
- {
- "fieldId": "field7",
- "localizedFieldId": "Field 7",
- "fieldName": "seven"
}
]
}List localized directory fields
Read all localized directory fields
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "localizedDirectoryField": [
- {
- "id": "field7",
- "localizedId": "Field 7",
- "label": "Location",
- "editable": true,
- "typeId": 1,
- "searchable": true
}
]
}Update localized directory fields
Update localized directory fields
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
Array of objects (LocalizedDirectoryFieldDTO) List of localized directory fields |
Responses
Request samples
- Payload
{- "localizedDirectoryField": [
- {
- "id": "field7",
- "localizedId": "Field 7",
- "label": "Location",
- "editable": true,
- "typeId": 1,
- "searchable": true
}
]
}The Mobile Configuration API is a group of methods to manage mobile configuration details.
Use the Mobile Configuration API to:
- Get address book configuration
- Create/update address book configuration
Get address book configuration
Get organization level mobile address book configuration.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "usersSync": "CURRENT_AND_LINKED_ORG_USERS",
- "externalContactsSync": "ALL_CONTACTS"
}Create/update address book configuration
Create or update address book configuration at the organization level.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/jsonrequired
| usersSync | string Enum: "DISABLED" "CURRENT_ORG_USERS_ONLY" "CURRENT_AND_LINKED_ORG_USERS" Type of synchronization for users. |
| externalContactsSync | string Enum: "DISABLED" "USER_CONTACTS_ONLY" "ALL_CONTACTS" Type of synchronization for external contacts. |
Responses
Request samples
- Payload
{- "usersSync": "CURRENT_AND_LINKED_ORG_USERS",
- "externalContactsSync": "ALL_CONTACTS"
}The Mobile Number Pool API is a group of methods to manage mobile number pools for an organization.
Use the Mobile Number Pool API to:
- Create mobile number pool
- Get mobile number pool
- Update mobile number pool
- Delete mobile number pool
Get mobile number pool
Retrieve the mobile number pool for an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Responses
Response samples
- 200
{- "mobileNumberPoolRange": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123",
- "sourceTags": "Incoming,Outgoing"
}
]
}Update mobile number pool
Update mobile number pool for an organization. Existing mobile number pools will be overwritten with what's included in the request.
Warning! If you run PUT with no numbers at all, all numbers will be removed. No numbers are removed if any error occurs.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema:
Array of objects (MobileNumberPoolRangeDTO) Array of number ranges |
Responses
Request samples
- Payload
{- "mobileNumberPoolRange": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123",
- "sourceTags": "Incoming,Outgoing"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create mobile number pool
If there already exist mobile number pools, those will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema:
Array of objects (MobileNumberPoolRangeDTO) Array of number ranges |
Responses
Request samples
- Payload
{- "mobileNumberPoolRange": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123",
- "sourceTags": "Incoming,Outgoing"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Number Conversion API is a group of methods to manage number conversions for an organization.
Use the Number Conversion API to:
- Get number conversions for organization
- Get number conversions for group
- Create number conversions for organization
- Create number conversions for group
- Update number conversions for organization
- Update number conversions for group
- Delete number conversions for organization
- Delete number conversions for group
Get number conversions
Read number conversions for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "numberConversion": [
- {
- "id": 1,
- "prefix": "+91",
- "lengthSuffix": 2,
- "prefixReplacement": "00091",
- "ranges": [
- {
- "start": 11,
- "stop": 88
}
]
}
]
}Update number conversions
Update organization number conversions. Existing number conversions will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: */*required
Array of objects (NumberPlanRuleDTO) List of number conversion rules |
Responses
Request samples
- Payload
{ "numberConversion": [ { "id": 1, "prefix": "+91", "lengthSuffix": 2, "prefixReplacement": "00091", "ranges": [ { "start": 11, "stop": 88 } ] } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create number conversions
Create number conversions for an organization. Existing number conversions will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: */*required
Array of objects (NumberPlanRuleDTO) List of number conversion rules |
Responses
Request samples
- Payload
{ "numberConversion": [ { "id": 1, "prefix": "+91", "lengthSuffix": 2, "prefixReplacement": "00091", "ranges": [ { "start": 11, "stop": 88 } ] } ] }
Get group number conversions
Read group number conversions of a usergroup.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| group required | string The name of the group |
Responses
Response samples
- 200
{- "numberConversion": [
- {
- "id": 1,
- "prefix": "+91",
- "lengthSuffix": 2,
- "prefixReplacement": "00091",
- "ranges": [
- {
- "start": 11,
- "stop": 88
}
]
}
]
}Update group number conversions
Update group number conversions. Existing number conversions will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| group required | string The name of the group |
Request Body schema: */*required
Array of objects (NumberPlanRuleDTO) List of number conversion rules |
Responses
Request samples
- Payload
{ "numberConversion": [ { "id": 1, "prefix": "+91", "lengthSuffix": 2, "prefixReplacement": "00091", "ranges": [ { "start": 11, "stop": 88 } ] } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create group number conversions
Create group number conversions. Existing number conversions will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| group required | string The name of the group |
Request Body schema: */*required
Array of objects (NumberPlanRuleDTO) List of number conversion rules |
Responses
Request samples
- Payload
{ "numberConversion": [ { "id": 1, "prefix": "+91", "lengthSuffix": 2, "prefixReplacement": "00091", "ranges": [ { "start": 11, "stop": 88 } ] } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Number Formatting API is a group of methods to manage number formatting, to be used for formatting of phone numbers in voice prompts, for an organization.
Use the Number Formatting API to:
- Create number formatting
- Get number formatting
- Update number formatting
- Delete number formatting
Update number formatting
Existing patterns will be overwritten with what's included in the request.
Warn! If you run PUT with no patterns at all, all patterns will be removed. No patterns are removed if any error occurs.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema: required
| orgId | integer <int32> The organization number. |
| pattern | Array of strings An array of patterns to be used for formatting of phone numbers in voice prompts. |
Responses
Request samples
- Payload
{- "pattern": [
- "+46 31 XX XX XX",
- "+46 8 X X X XX XX",
- "+46 8 XX XX XX XX"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create number formatting
If there already exist patterns, those will be overwritten with what's included in the request.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema: required
| orgId | integer <int32> The organization number. |
| pattern | Array of strings An array of patterns to be used for formatting of phone numbers in voice prompts. |
Responses
Request samples
- Payload
{- "pattern": [
- "+46 31 XX XX XX",
- "+46 8 X X X XX XX",
- "+46 8 XX XX XX XX"
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Number Ranges API is a group of methods to manage number ranges for an organization.
Use the Number Ranges API to:
- List number ranges
- Update number ranges
List number ranges
Retrieve number ranges for an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Responses
Response samples
- 200
{- "numberRange": [
- {
- "first": 1000,
- "last": 1299,
- "length": 4,
- "prefix": "+4681111",
- "sourceTags": "Incoming,Outgoing",
- "useForAutoProvisioning": true
}
]
}Update number ranges
Update number ranges for an organization. Existing number ranges will be overwritten with what's included in the request.
Warn! If you run PUT with no number ranges at all, all number ranges will be removed. No number ranges are removed if any error occurs.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema:
Array of objects (NumberRangeDTO) Array of number ranges |
Responses
Request samples
- Payload
{- "numberRange": [
- {
- "first": 1000,
- "last": 1299,
- "length": 4,
- "prefix": "+4681111",
- "sourceTags": "Incoming,Outgoing",
- "useForAutoProvisioning": true
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Organization Device Location API is a group of methods to manage device locations for an organization.
Use the Organization Device Location API to:
- Get device locations
- Update device locations
Get device locations
Retrieve device locations for an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Responses
Response samples
- 200
{- "deviceLocation": [
- {
- "fullPathName": "Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899998000",
- "cesid": "+46899999000",
- "locationId": "+46812345000",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}, - {
- "defaultCesid": "+46812345000"
}
], - "parent": [
- "Sweden",
- "Sweden/Stockholm",
- "default"
]
}Update device locations
Update device locations for an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema: required
Array of objects (DeviceLocationDTO) Array of device locations | |
| parent | Array of strings Array of available system level device locations which may be used and paths to organization level device locations. |
Responses
Request samples
- Payload
{- "deviceLocation": [
- {
- "fullPathName": "Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899998000",
- "cesid": "+46899999000",
- "locationId": "+46812345000",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}, - {
- "defaultCesid": "+46812345000"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Organization Language API is a group of methods to manage the languages for an organization.
Use Organization Language API to:
- Create organization language
- Get default organization language
- Set default organization language
- Delete organization language
- list organization languages
Get default organization language
Retrieve the default language for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | string The language id (Two-letter ISO 639-1 code) |
Responses
Response samples
- 200
- 400
{- "languageId": "en",
- "defaultLanguage": true,
- "displayString": "English"
}Delete organization language
Delete an organization language.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | string The language id (Two-letter ISO 639-1 code) |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List organization languages
Retrieve a list of possible languages that can be set for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
- 400
[- {
- "languageId": "en",
- "defaultLanguage": true,
- "displayString": "English"
}
]Create organization language
Adds a new organization language.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| languageId | string The language id (Two-letter ISO 639-1 code) |
| defaultLanguage | boolean Whether it is default language or not |
| displayString | string The name of the language |
Responses
Request samples
- Payload
{- "languageId": "en",
- "defaultLanguage": true,
- "displayString": "English"
}Update default organization language
Update the default language for the organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | string The language id (Two-letter ISO 639-1 code) |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Organization License API is a group of methods to manage licenses for an organization.
Use the Organization License API to:
- Get organization license report
- List organization licenses
- Update organization licenses
Get organization license report
Use this method to fetch the license report for the specified organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "activated": false,
- "organization": "test",
- "domain": "test.com",
- "customerId": "1234",
- "collaborationOrgId": "PjuULeH1FUAJ7ZvXUAfHVZA",
- "license": [
- {
- "name": "Unified_Inbox_User_Add-on",
- "component": "UNIFIED_MESSAGING",
- "current": 10,
- "peak": 15,
- "churn": 5,
- "quota": 20
}
]
}List organization licenses
This method fetches the licenses available for the organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| includecurrent | boolean If set to true, the number of currently used unit licenses are included in the response |
Responses
Response samples
- 200
List licenses
{- "license": [
- {
- "component": "ACD_LIGHT",
- "quota": "10"
}, - {
- "component": "SIP_REGISTRAR",
- "quota": "25"
}, - {
- "component": "TEAMS_TELEPHONY"
}, - {
- "component": "GROUPS_CALL_LOG",
- "quota": "2"
}
]
}Update organization licenses
Use this method to update the licenses for an organization.
Updating license quota can cause the following errors:
organization.license.component - Update failed because there are not enough license entries available for the license.
organization.license.quota - Invalid format of the quota.
organization.license.component.readonly - It is not possible to update a read only license.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: required
Array of objects (LicenseDTO) A list of licenses |
Responses
Request samples
- Payload
{- "license": [
- {
- "component": "ACD_LIGHT",
- "quota": "10"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Organization Limits API is a group of methods to manage limits for an organization.
Use the Organization Limits API to:
- Get organization limits
- Update organization limits
- Delete organization limits
Get organization limits
This method fetches the limits set for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "registrationLimitPolicy": "Inherit",
- "concurrentCalls": 3,
- "concurrentDivertedCalls": 3,
- "concurrent3rdPartyCalls": 3,
- "maxParticipantsPerConference": 3,
- "maxParticipantsPerConferenceLimit": 3
}Update organization limits
Use this method to update the limit settings for an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| registrationLimitPolicy | string Enum: "Inherit" "Unlimited" "Limited" The policy for limiting the number of registrations |
| concurrentCalls | integer <int32> Number of concurrent call limit (0 means not configured) |
| concurrentDivertedCalls | integer <int32> Maximum number of concurrent diverted calls per user. |
| concurrent3rdPartyCalls | integer <int32> Number of concurrent calls on third party phones (0 means not configured) |
| maxParticipantsPerConference | integer <int32> Max number of participants per conference (0 means limited by maxParticipantsPerConferenceLimit) |
Responses
Request samples
- Payload
{- "registrationLimitPolicy": "Inherit",
- "concurrentCalls": 3,
- "concurrentDivertedCalls": 3,
- "concurrent3rdPartyCalls": 3,
- "maxParticipantsPerConference": 3
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete organization limits
Delete or reset the limits set for an organization. This causes it to fallback to system defaults.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| param required | string The value is one of the strings all, concurrent3rdPartyCalls or concurrentCalls. Refer the response documentation for GET request for details of these parameters |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Organization Property API is a group of methods to fetch properties for an organization.
Use the Organization Property API to:
- Get if the organization has call recording enabled
- List localized presence activites labels
- List localized presence roles labels
Get configuration
Get configuration for Premium call recording
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "digitsToMask": 0,
- "maskInternalCalls": true,
- "maskIncomingExternalCalls": true,
- "maskOutgoingExternalCalls": true,
- "offboarded": true
}Update configuration
Update configuration for Premium call recording
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: */*
| digitsToMask | integer <int32> Represents the number of digits to mask. |
| maskInternalCalls | boolean Whether phone number masking is applicable for internal calls. |
| maskIncomingExternalCalls | boolean Whether phone number masking is applicable for incoming external calls. |
| maskOutgoingExternalCalls | boolean Whether phone number masking is applicable for outgoing external calls. |
| offboarded | boolean Set to true to trigger the offboarding process. See the documentation for the full impact of this action. |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get localized activity labels
Retrieve activity presence states with localized labels.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| language | string Example: language=sv The language in which to get the localized labels. If omitted, the organization default language is used. The language parameter should contain correct ISO 639-1 language code, i.e. use 'sv' to get Swedish or en-us to get English (United States) resource bundles |
Responses
Response samples
- 200
Available activites with organization's default localization
{- "activity": [
- {
- "id": "available",
- "name": "Available",
- "available": true,
- "default": true,
- "stateName": "Available"
}, - {
- "id": "lunch",
- "name": "Lunch",
- "available": false,
- "default": false,
- "stateName": "Lunch"
}, - {
- "id": "meeting",
- "name": "Meeting",
- "available": false,
- "default": false,
- "stateName": "Meeting"
}
]
}Get localized role labels
Retrieve presence roles with localized labels.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
query Parameters
| language | string Example: language=sv The language in which to get the localized labels. If omitted, the organization default language is used. The language parameter should contain correct ISO 639-1 language code, i.e. use 'sv' to get Swedish or en-us to get English (United States) resource bundles |
Responses
Response samples
- 200
Available roles with organization's default localization
{- "role": [
- {
- "id": "business",
- "name": "Business",
- "stateName": "Business"
}, - {
- "id": "private",
- "name": "Private",
- "stateName": "Private"
}, - {
- "id": "1400593658949",
- "name": "Support",
- "stateName": "Support"
}
]
}The Prompt API is used to manage prompts for organizations.
Use the Prompt API to:
- Create a new prompt for the organization and upload files to it
- Get information about a single prompt for an organization
- List files of the current prompts in an organization
- Update an existing organization prompt
- Delete an existing organization prompt
Get prompt metadata
Retrieves the metadata of a specific prompt.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Responses
Response samples
- 200
{- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Update prompt
Updates prompt identified by the supplied organization and id.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Request Body schema: application/json
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create prompt metadata
Adds metadata to create a new prompt with a unique id supplied for this prompt.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Request Body schema: application/json
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete prompt
Removes prompt identified by the supplied organization and id.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get prompt metadata Deprecated
Retrieves the metadata of a specific prompt.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Responses
Response samples
- 200
{- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Update prompt Deprecated
Updates prompt identified by the supplied organization and id.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Request Body schema:
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create prompt metadata Deprecated
Adds metadata to create a new prompt with a unique id supplied for this prompt.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Request Body schema:
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Delete prompt Deprecated
Removes prompt identified by the supplied organization and id.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
Responses
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get prompt file
Retrieves a specific prompt file.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| download | boolean Specifies if the prompt should be downloaded as file |
Responses
Update prompt file
Updates a file to specified prompt of an organization, for the language provided.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| description | string Description of the prompt |
Request Body schema: multipart/form-data
object | |
object | |
| preamble | string |
Array of objects (InputPart) |
Responses
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Upload prompt file
Uploads a file to specified prompt of an organization, for the language provided.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| description | string Description of the prompt |
Request Body schema: multipart/form-data
object | |
object | |
| preamble | string |
Array of objects (InputPart) |
Responses
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get prompt file Deprecated
Retrieves a specific prompt file.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| download | boolean Specifies if the prompt should be downloaded as file |
Responses
Update prompt file Deprecated
Updates a file to specified prompt of an organization, for the language provided.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| description | string Description of the prompt |
Request Body schema: multipart/form-data
object | |
object | |
| preamble | string |
Array of objects (InputPart) |
Responses
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Upload prompt file Deprecated
Uploads a file to specified prompt of an organization, for the language provided.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
| language required | string Prompt language in ISO-639 format or '' |
query Parameters
| description | string Description of the prompt |
Request Body schema: multipart/form-data
object | |
object | |
| preamble | string |
Array of objects (InputPart) |
Responses
Response samples
- 200
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List prompts
Retrieves a list of the prompts for an organization.
Authorizations:
path Parameters
| domain required | string The domain of target organization |
Responses
Response samples
- 200
{- "prompt": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}
]
}Create prompt metadata
Adds metadata to create a new prompt and returns a generated id for the prompt.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
Request Body schema: application/json
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Create prompt metadata Deprecated
Adds metadata to create a new prompt and returns a generated id for the prompt.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
Request Body schema:
| name required | string The name of the prompt |
| description | string Description of the prompt |
| modifiable | boolean If the prompt file can be modified or not |
| reseller | string The name of the reseller for which the prompt is defined |
| type | string Enum: "SERVICE" "TECHNICAL" The type of prompt |
| url | string The url of the prompt |
Array of objects (PromptLanguageDTO) List of languages |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "modifiable": true,
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Response samples
- 200
- 400
{- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}Delete prompt
Removes prompt identified by the supplied organization and id.
Authorizations:
path Parameters
| domain required | string Domain of target organization |
| id required | string Id of the prompt |
query Parameters
| forceDelete | boolean Specifies if the prompt should be deleted forcefully and replaced with a silence prompt, even it is currently used. |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}List prompts Deprecated
Retrieves a list of the prompts for an organization.
NOTE: This method is DEPRECATED since 5.1 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of target organization |
Responses
Response samples
- 200
{- "prompt": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "modifiable": true,
- "modifiedTime": "string",
- "reseller": "string",
- "type": "SERVICE",
- "url": "string",
- "language": [
- {
- "locale": "string",
- "description": "string",
- "reseller": "string",
- "url": "string",
- "overridable": true,
- "modifiable": true,
- "overridenLanguages": [
- { }
]
}
]
}
]
}The Search API is used to search in fields for users, mobile subscribers, function numbers, desk phones and number ranges.
Use the Search API to:
- Search
Search
The search API is used to search in field for users, mobile subscribers, function numbers, desk phones and number ranges.
Authorizations:
query Parameters
| maxHits | string Number of maximum search results per type. If excluded, 10 is used as default value, i.e max 10 entities per type are returned. |
Request Body schema: required
| searchString required | string The string to search for, can be either name or number |
| types required | Array of strings Items Enum: "USER" "FUNCTION_NUMBER" "DESK_PHONE" "NUMBER_RANGE" "MOBILE_SUBSCRIBER" List of types where search will be performed |
Responses
Request samples
- Payload
Search everywhere except number ranges for given string
{- "searchString": "Example",
- "types": [
- "USER",
- "FUNCTION_NUMBER",
- "DESK_PHONE",
- "MOBILE_SUBSCRIBER"
]
}Response samples
- 200
Search everywhere except number ranges for given string
{- "isComplete": true,
- "searchString": "Example",
- "encodedSearchString": "Example",
- "types": [
- "USER",
- "FUNCTION_NUMBER",
- "DESK_PHONE",
- "MOBILE_SUBSCRIBER"
], - "users": [
- {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.4155154,
- "loginId": "jane@example.org",
- "firstName": "Jane",
- "lastName": "Doe",
- "primaryNumber": "+123467891",
- "secondaryNumber": "+123460010",
- "mobileNumbers": [
- "+46815120"
], - "aliases": [
- "7891"
], - "email": "jane.doe@example.org",
- "billingId": "+123467890",
- "department": "Example department",
- "mobileStatus": "INVITED",
- "mobileStatusDate": "2021-01-01 08:00:00",
- "federatedIdentity": "jane.doe@externalmail.com"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.4155154,
- "loginId": "john@example.org",
- "firstName": "John",
- "lastName": "Doe",
- "primaryNumber": "+123467890",
- "secondaryNumber": "+123460000",
- "mobileNumbers": [
- "+46815110"
], - "aliases": [
- "7890"
], - "email": "john.doe@example.org",
- "billingId": "+123467890",
- "department": "Example department"
}
], - "functionNumbers": [
- {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.8526316,
- "number": "+46899995006",
- "type": "ACD",
- "name": "Acd Group 1"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.005334,
- "number": "+46899995007",
- "type": "ACD_LIGHT",
- "name": "AcdLight"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.005334,
- "number": "+46899995001",
- "type": "ATTENDANT",
- "name": "Attendant"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.005334,
- "number": "+123400",
- "type": "AUTO_ATTENDANT",
- "name": "AutoAttendant"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.005334,
- "number": "+46899995020",
- "type": "HUNT_GROUP",
- "name": "HuntGroup1"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46899995060",
- "type": "CONFERENCE",
- "name": ""
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 4.005334,
- "number": "+46899995170",
- "type": "FAX_NUMBER",
- "name": "HeadOffice FAX"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46899995190",
- "type": "EXTERNAL_SYSTEM",
- "name": "External System 1"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46899995100",
- "type": "IVR_MENU",
- "name": "IVR number"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46840837751",
- "type": "RULE_BASED",
- "name": "PublicRBN"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46765964166",
- "type": "SHARED_LINE",
- "name": "Shared Line"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46765964122",
- "type": "GROUP_INBOX",
- "name": "Group Inbox for Example"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46765959000",
- "type": "GROUP_INBOX_RETRIEVAL",
- "name": ""
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 3.3862944,
- "number": "+46765959191",
- "type": "VOICEMAIL_RETRIEVAL",
- "name": ""
}
], - "deskPhones": [
- {
- "domain": "example.org",
- "orgName": "Example",
- "score": 2,
- "mac": "00085D58CDEB",
- "type": "mitel6867i",
- "assignedUsers": [
- {
- "userId": "john@example.org",
- "userName": "John Doe"
}
]
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 2,
- "mac": "00085D448274",
- "type": "mitel6869i"
}
], - "mobileSubscribers": [
- {
- "domain": "example.org",
- "orgName": "Example",
- "score": 1,
- "mobileNumber": "+46815102",
- "subscriptionType": "MOBILE_VPN",
- "firstName": "User",
- "lastName": "Example"
}, - {
- "domain": "example.org",
- "orgName": "Example",
- "score": 1,
- "mobileNumber": "+46815101",
- "subscriptionType": "MEX",
- "firstName": "Example",
- "lastName": "User",
- "alias": "+46812345008",
- "shortNumber": "2008"
}
]
}The User Group API is a group of methods to manage user groups for an organization.
Use the User Group API to:
- Create user group
- Update user group
- Get user group
- Get user group info
- Get all user groups
- Get user group including users
- Delete user group
Get user group
Get details of a user group in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupName required | string The name of the user group |
Responses
Response samples
- 200
{- "reportAdmin": false,
- "acdSupervisor": true,
- "locked": false,
- "schedulesAdmin": false,
- "federated": true,
- "moderator": false,
- "barring": false,
- "name": "ACD supervisor"
}Update user group
Modify an existing user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupName required | string The name of the user group |
Request Body schema: required
| reportAdmin | boolean Whether the members of this user group allows to generate reports or not |
| acdSupervisor | boolean Whether the group members can act as ACD supervisors or not. A group with ACD Supervisor enabled can be selected as Supervisor for different function numbers, including Attendant groups or ACD groups |
| locked | boolean Whether the user group is locked or not. It is possible for Super Users and Limited Super Users to lock individual user groups per organization. The locking option is only visible for Super Users and Limited Super Users. When a user group is locked, the Delete button is disabled for organization administrators. |
| schedulesAdmin | boolean Whether the user group has schedule privileage. A Schedules administrator can add schedule events. Schedules are used to set opening hours on function numbers |
| federated | boolean Whether the user group is federated or not. A user group with Federation privileges is available as a user group in its own organization, and available for features in all linked organizations. This means that an organization administrator in a linked organization can add features for users from where the user group is derived. This setting can only be selected if the current organization belongs to a federation |
| moderator | boolean Whether it is a moderator group or not |
| barring | boolean Whether it is a barring group or not |
Responses
Request samples
- Payload
{- "reportAdmin": false,
- "acdSupervisor": true,
- "locked": false,
- "schedulesAdmin": false,
- "federated": true,
- "moderator": false,
- "barring": false,
- "name": "ACD supervisor"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create user group
Create a new user group in an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupName required | string The name of the user group |
Request Body schema: required
| reportAdmin | boolean Whether the members of this user group allows to generate reports or not |
| acdSupervisor | boolean Whether the group members can act as ACD supervisors or not. A group with ACD Supervisor enabled can be selected as Supervisor for different function numbers, including Attendant groups or ACD groups |
| locked | boolean Whether the user group is locked or not. It is possible for Super Users and Limited Super Users to lock individual user groups per organization. The locking option is only visible for Super Users and Limited Super Users. When a user group is locked, the Delete button is disabled for organization administrators. |
| schedulesAdmin | boolean Whether the user group has schedule privileage. A Schedules administrator can add schedule events. Schedules are used to set opening hours on function numbers |
| federated | boolean Whether the user group is federated or not. A user group with Federation privileges is available as a user group in its own organization, and available for features in all linked organizations. This means that an organization administrator in a linked organization can add features for users from where the user group is derived. This setting can only be selected if the current organization belongs to a federation |
| moderator | boolean Whether it is a moderator group or not |
| barring | boolean Whether it is a barring group or not |
Responses
Request samples
- Payload
{- "reportAdmin": false,
- "acdSupervisor": true,
- "locked": false,
- "schedulesAdmin": false,
- "federated": false,
- "moderator": false,
- "barring": false,
- "name": "ACD supervisor"
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get user group with users
Retrieve user group info including users
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupName required | string The name of the user group |
Responses
Response samples
- 200
{- "reportAdmin": false,
- "acdSupervisor": true,
- "locked": false,
- "schedulesAdmin": false,
- "federated": true,
- "moderator": false,
- "barring": false,
- "name": "ACD supervisor",
- "user": [
- {
- "name": "Alice Bob",
- "userId": "albo",
- "primaryNumber": "+46765966"
}, - {
- "name": "John Doe",
- "userId": "jodo",
- "primaryNumber": "+46765967"
}
]
}List user groups
Retrieve all user groups of an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "groups": [
- {
- "reportAdmin": false,
- "acdSupervisor": true,
- "locked": false,
- "schedulesAdmin": false,
- "federated": true,
- "moderator": false,
- "barring": false,
- "name": "ACD supervisor"
}, - {
- "reportAdmin": true,
- "acdSupervisor": false,
- "locked": false,
- "schedulesAdmin": false,
- "federated": false,
- "moderator": false,
- "barring": false,
- "name": "Report handler"
}
]
}The Voicemail Settings API is a group of methods to manage Voicemail Settings at organization, user group and user levels.
Use the Voicemail Settings API to:
- Get voicemail settings on organization level
- Get voicemail settings on group level
- Get voicemail settings on user level
- Update voicemail settings on organization level
- Update voicemail settings on group level
- Update voicemail settings on user level
- Reset voicemail settings on organization level
- Reset voicemail settings on group level
- Reset voicemail settings on user level
Get organization settings
Retrieve voicemail settings for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "playActivity": true,
- "playMergedUnavailableEndTime": false,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": true,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 12,
- "maxInboxSize": 11,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}Update organization settings
Update voicemail settings for an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/jsonrequired
| playActivity | boolean Whether the greeting played when a caller reaches the voice mail service will include information about callee's current activity. |
| playMergedUnavailableEndTime | boolean Whether the end time of the last consecutive activity present with unavailable status. |
| playHumanAssistance | boolean Whether the human assistance option should be played out as part of the greeting. |
| humanAssistanceNumber | string The number that the human assistance option redirects to, if the 'playHumanAssistance' value set to true. |
| smsNotification | boolean Whether SMS should be used for new voicemail messages notifications. |
| emailNotification | boolean Whether email should be used for new voicemail messages notifications. |
| fileAttached | boolean Whether the voicemail is to be attached to the email notifications. |
| voicemailInboxFullSmsNotification | boolean Whether SMS notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| voicemailInboxFullEmailNotification | boolean Whether email notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| allowDownload | boolean Whether the users are allowed to download vociemails to their mobile from the inbox page of the mobile app. |
| allowVoicemail | boolean Whether the callers are allowed to deposit voicemail messages. |
| bypassVoicemail | boolean Whether bypass voicemail as part of the greeting. |
| voicemailCallbackEnabled | boolean Whether the user will get the option to call back to the number that left the voicemail message. |
| hidePortalLink | boolean Whether the link to the user portal should be removed from the notification. |
| allowPersonalGreeting | boolean Whether the users are allowed to define their own personal greeting. |
| allowDisableVoicemail | boolean Whether the users are allowed to enable/disable voicemail message deposit. |
| pinRequired | boolean Whether PIN is required to retrieve vociemail messages. |
| userLanguage | boolean Whether can use the user's language for external callers. |
| retentionTime | integer <int32> Indicates how long should old messages be saved before they are automatically deleted. |
| maxInboxSize | integer <int32> Indicates the max size of the inbox in megabytes. |
| greetingPromptId | string Default greeting for users with no personal greeting. |
| smsNotificationNumberCount | string The Number of voicemail retrieval numbers to include in SMS notifications. |
Responses
Request samples
- Payload
{- "playActivity": true,
- "playMergedUnavailableEndTime": false,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": true,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 12,
- "maxInboxSize": 11,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}Get user settings
Retrieve voicemail settings for a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| userId required | string The user id of the user |
Responses
Response samples
- 200
{- "playActivity": false,
- "playMergedUnavailableEndTime": true,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": false,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 10,
- "maxInboxSize": 10,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}Update user settings
Update voicemail settings for a user.
Authorizations:
path Parameters
| domain required | string The organization domain |
| userId required | string The user id of the user |
Request Body schema: application/jsonrequired
| playActivity | boolean Whether the greeting played when a caller reaches the voice mail service will include information about callee's current activity. |
| playMergedUnavailableEndTime | boolean Whether the end time of the last consecutive activity present with unavailable status. |
| playHumanAssistance | boolean Whether the human assistance option should be played out as part of the greeting. |
| humanAssistanceNumber | string The number that the human assistance option redirects to, if the 'playHumanAssistance' value set to true. |
| smsNotification | boolean Whether SMS should be used for new voicemail messages notifications. |
| emailNotification | boolean Whether email should be used for new voicemail messages notifications. |
| fileAttached | boolean Whether the voicemail is to be attached to the email notifications. |
| voicemailInboxFullSmsNotification | boolean Whether SMS notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| voicemailInboxFullEmailNotification | boolean Whether email notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| allowDownload | boolean Whether the users are allowed to download vociemails to their mobile from the inbox page of the mobile app. |
| allowVoicemail | boolean Whether the callers are allowed to deposit voicemail messages. |
| bypassVoicemail | boolean Whether bypass voicemail as part of the greeting. |
| voicemailCallbackEnabled | boolean Whether the user will get the option to call back to the number that left the voicemail message. |
| hidePortalLink | boolean Whether the link to the user portal should be removed from the notification. |
| allowPersonalGreeting | boolean Whether the users are allowed to define their own personal greeting. |
| allowDisableVoicemail | boolean Whether the users are allowed to enable/disable voicemail message deposit. |
| pinRequired | boolean Whether PIN is required to retrieve vociemail messages. |
| userLanguage | boolean Whether can use the user's language for external callers. |
| retentionTime | integer <int32> Indicates how long should old messages be saved before they are automatically deleted. |
| maxInboxSize | integer <int32> Indicates the max size of the inbox in megabytes. |
| greetingPromptId | string Default greeting for users with no personal greeting. |
| smsNotificationNumberCount | string The Number of voicemail retrieval numbers to include in SMS notifications. |
Responses
Request samples
- Payload
{- "playActivity": false,
- "playMergedUnavailableEndTime": true,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": false,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 10,
- "maxInboxSize": 10,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}Get user group settings
Retrieve voicemail settings for a user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Responses
Response samples
- 200
{- "playActivity": true,
- "playMergedUnavailableEndTime": false,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": false,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 9,
- "maxInboxSize": 14,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}Update user group settings
Update voicemail settings for a user group.
Authorizations:
path Parameters
| domain required | string The organization domain |
| groupId required | string The name of the user group |
Request Body schema: application/jsonrequired
| playActivity | boolean Whether the greeting played when a caller reaches the voice mail service will include information about callee's current activity. |
| playMergedUnavailableEndTime | boolean Whether the end time of the last consecutive activity present with unavailable status. |
| playHumanAssistance | boolean Whether the human assistance option should be played out as part of the greeting. |
| humanAssistanceNumber | string The number that the human assistance option redirects to, if the 'playHumanAssistance' value set to true. |
| smsNotification | boolean Whether SMS should be used for new voicemail messages notifications. |
| emailNotification | boolean Whether email should be used for new voicemail messages notifications. |
| fileAttached | boolean Whether the voicemail is to be attached to the email notifications. |
| voicemailInboxFullSmsNotification | boolean Whether SMS notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| voicemailInboxFullEmailNotification | boolean Whether email notifications should be used when the voicemail inbox approaches it's maximum capacity. |
| allowDownload | boolean Whether the users are allowed to download vociemails to their mobile from the inbox page of the mobile app. |
| allowVoicemail | boolean Whether the callers are allowed to deposit voicemail messages. |
| bypassVoicemail | boolean Whether bypass voicemail as part of the greeting. |
| voicemailCallbackEnabled | boolean Whether the user will get the option to call back to the number that left the voicemail message. |
| hidePortalLink | boolean Whether the link to the user portal should be removed from the notification. |
| allowPersonalGreeting | boolean Whether the users are allowed to define their own personal greeting. |
| allowDisableVoicemail | boolean Whether the users are allowed to enable/disable voicemail message deposit. |
| pinRequired | boolean Whether PIN is required to retrieve vociemail messages. |
| userLanguage | boolean Whether can use the user's language for external callers. |
| retentionTime | integer <int32> Indicates how long should old messages be saved before they are automatically deleted. |
| maxInboxSize | integer <int32> Indicates the max size of the inbox in megabytes. |
| greetingPromptId | string Default greeting for users with no personal greeting. |
| smsNotificationNumberCount | string The Number of voicemail retrieval numbers to include in SMS notifications. |
Responses
Request samples
- Payload
{- "playActivity": true,
- "playMergedUnavailableEndTime": false,
- "playHumanAssistance": false,
- "smsNotification": false,
- "emailNotification": true,
- "fileAttached": false,
- "voicemailInboxFullSmsNotification": false,
- "voicemailInboxFullEmailNotification": true,
- "allowDownload": true,
- "allowVoicemail": true,
- "bypassVoicemail": false,
- "voicemailCallbackEnabled": false,
- "hidePortalLink": true,
- "allowPersonalGreeting": true,
- "allowDisableVoicemail": false,
- "pinRequired": false,
- "userLanguage": false,
- "retentionTime": 9,
- "maxInboxSize": 14,
- "greetingPromptId": "system_no_answer_greeting",
- "smsNotificationNumberCount": "ONE"
}The Call Tags API is used to be able to easily set which trunk group a call should break out on.The tags can be specified on organization, group or even user level
Use the Call tags API to:
- Get call tags service group priority
- Update call tags service group priority
- Get all available call tags for an organization
- Get call tags configured for an organization
- Update call tags configured for an organization
- Get call tags configured for a user group
- Update call tags configured for a user group
- Get call tags configured for a user
- Update call tags configured for a user
Update service group priority
Update call tags service group priority
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| groups | Array of strings User groups. The groups are listed in the priority order. |
Responses
Request samples
- Payload
{- "groups": "sales"
}Get user group call tags
Read call tags configured for a user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Responses
Response samples
- 200
{- "override": "KEEP_NUMBER_RANGE_TAGS",
- "callerTag": "callertag1"
}Update user group call tags
Update call tags configured for a user group.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Request Body schema:
| override | string Enum: "EMPTY" "APPEND" "REPLACE" "KEEP_NUMBER_RANGE_TAGS" Defines how the caller tags interact with the number range based source tags |
| callerTag | Array of strings unique A list of caller tags |
Responses
Request samples
- Payload
{- "override": "KEEP_NUMBER_RANGE_TAGS",
- "callerTag": "callertag1"
}Update organization call tags
Update call tags configured for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| override | string Enum: "EMPTY" "APPEND" "REPLACE" "KEEP_NUMBER_RANGE_TAGS" Defines how the caller tags interact with the number range based source tags |
| callerTag | Array of strings unique A list of caller tags |
Responses
Request samples
- Payload
{- "override": "KEEP_NUMBER_RANGE_TAGS",
- "callerTag": "callertag1"
}Update user call tags
Update call tags configured for a user.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Request Body schema:
| override | string Enum: "EMPTY" "APPEND" "REPLACE" "KEEP_NUMBER_RANGE_TAGS" Defines how the caller tags interact with the number range based source tags |
| callerTag | Array of strings unique A list of caller tags |
Responses
Request samples
- Payload
{- "override": "KEEP_NUMBER_RANGE_TAGS",
- "callerTag": "callertag1"
}The Organization API is a group of methods to manage settings for an organization.
Use the Organization API to:
- Create organization
- Get organization
- Get organization id
- Update organization
- Delete organization
Get organization
Use this method to retrieve organization details.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "uniqueId": "(telepo-id):-1uzpth0f59fq4-1l3ngbvtuk5le:foo.com",
- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "billingId": "+46899995000",
- "note": "Added some note",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": false,
- "collaboration": true,
- "organizationId": 2,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [
- {
- "component": "COLLABORATION_LICENSE",
- "quota": "1"
}, - {
- "component": "CONFERENCING",
- "quota": "50"
}, - {
- "component": "SOFTPHONE"
}, - {
- "component": "MITEAM_COLLABORATION_LICENSE",
- "quota": "50"
}, - {
- "component": "CLOUD_CRM_CONNECTOR"
}
], - "deviceLocations": [
- {
- "fullPathName": "Default location/Sweden"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899995100",
- "cesid": "+468999995100",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}
], - "mobileNumberPool": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123"
}
]
}Update organization
Use this method to update an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/jsonrequired
| name required | string The name of the organization. |
| uniqueId | string A unique identifier for the organization. |
| locked | boolean Whether the organization is locked or not, either true or false. |
| domain | string The domain of the organization, a valid domain name, maximum 64 characters long, with syntax according to RFC883, but uppercase letters are not allowed. |
| reseller | string The reseller the organization belongs to, if omitted the reseller will be set to default. |
| backup | string The name of your backup of the organization template, mandatory field in POST, not to be used in PUT. The organization template backup needs to be uploaded to the management node prior to executing this method. |
| customerId | string An optional customer identity. |
| billingId | string An optional billing identity. |
| note | string An optional note. |
| defaultPhoneLine | string Value: "PRIMARY or SECONDARY" Which phone line should be the default on each user. If omitted, it is set to PRIMARY. |
| nodeId | string Node ID for the service node this organization resides on. |
| runWizard | boolean Set to true if organization wizard should be shown when admins login. The wizard will be shown if the wizard has not been completed. |
| collaboration | boolean Whether the organization has activated collaboration or not, either true or false. |
| cloudCrmConnectorWebHookUrl | string Webhook URL to the external integrated CRM system. |
| organizationId | integer <int32> The identity number of the organization. |
Array of objects (NumberRangeDTO) A list of the available number ranges for the organization. | |
Array of objects (LicenseDTO) A list of license quotas. | |
Array of objects (DeviceLocationDTO) A list of the available device locations for the organization | |
| countryCode | string Country code. Two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value.If the setting is omitted at PUT, the value will not change. |
Array of objects (MobileNumberPoolRangeDTO) A list of the available mobile number ranges for the organization. |
Responses
Request samples
- Payload
{- "uniqueId": "(telepo-id):-1uzpth0f59fq4-1l3ngbvtuk5le:foo.com",
- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "billingId": "+46899995000",
- "note": "Added some note",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": false,
- "organizationId": 2,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [
- {
- "component": "COLLABORATION_LICENSE",
- "quota": "1"
}, - {
- "component": "CONFERENCING",
- "quota": "50"
}, - {
- "component": "SOFTPHONE"
}, - {
- "component": "MITEAM_COLLABORATION_LICENSE",
- "quota": "50"
}, - {
- "component": "CLOUD_CRM_CONNECTOR"
}
], - "deviceLocations": [
- {
- "fullPathName": "Default location/Sweden"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899995100",
- "cesid": "+468999995100",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}
], - "mobileNumberPool": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create organization
Creates a new organization.
Note: When creating an organization via the API, organization administrators are not created automatically. They need to be created separately.
Note: If the node id is not specified, new organizations are by default placed on the service node with the least number of organizations. This will be the spare node, if that is not set in maintenance mode.
When creating organizations, it will take approx 30 s (data will propagate to the cluster) for the Management Node to synchronise data with the Service nodes. In other words, for a short time the Management node will not be aware that a new organization is present on the system.
Therefore, if you create an organization on a specific System node and then make immediate API-requests to it, for instance adding Users, they will fail. There is a way around the problem, you can include the Node ID in the API-request and subsequent requests as to ensure that the task is performed on the correct node even if the Management Node is not yet aware of the existence of the organization.
When creating an organization, it is no longer necessary to specify the number ranges.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
query Parameters
| nodeid | string The node id of the service node to create the organization on. |
| load-template-quotas | boolean Whether or not some license quotas should be preloaded from the backup. If not, license quotas are preloaded with the default value. See documentation for details. |
Request Body schema: application/jsonrequired
| name required | string The name of the organization. |
| uniqueId | string A unique identifier for the organization. |
| locked | boolean Whether the organization is locked or not, either true or false. |
| domain | string The domain of the organization, a valid domain name, maximum 64 characters long, with syntax according to RFC883, but uppercase letters are not allowed. |
| reseller | string The reseller the organization belongs to, if omitted the reseller will be set to default. |
| backup | string The name of your backup of the organization template, mandatory field in POST, not to be used in PUT. The organization template backup needs to be uploaded to the management node prior to executing this method. |
| customerId | string An optional customer identity. |
| billingId | string An optional billing identity. |
| note | string An optional note. |
| defaultPhoneLine | string Value: "PRIMARY or SECONDARY" Which phone line should be the default on each user. If omitted, it is set to PRIMARY. |
| nodeId | string Node ID for the service node this organization resides on. |
| runWizard | boolean Set to true if organization wizard should be shown when admins login. The wizard will be shown if the wizard has not been completed. |
| collaboration | boolean Whether the organization has activated collaboration or not, either true or false. |
| cloudCrmConnectorWebHookUrl | string Webhook URL to the external integrated CRM system. |
| organizationId | integer <int32> The identity number of the organization. |
Array of objects (NumberRangeDTO) A list of the available number ranges for the organization. | |
Array of objects (LicenseDTO) A list of license quotas. | |
Array of objects (DeviceLocationDTO) A list of the available device locations for the organization | |
| countryCode | string Country code. Two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value.If the setting is omitted at PUT, the value will not change. |
Array of objects (MobileNumberPoolRangeDTO) A list of the available mobile number ranges for the organization. |
Responses
Request samples
- Payload
{- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "backup": "org_template",
- "billingId": "+46899995500",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": true,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [ ],
- "deviceLocations": [ ],
- "mobileNumberPool": [ ]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get organization Deprecated
Use this method to retrieve organization details.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Responses
Response samples
- 200
{- "uniqueId": "(telepo-id):-1uzpth0f59fq4-1l3ngbvtuk5le:foo.com",
- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "billingId": "+46899995000",
- "note": "Added some note",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": false,
- "collaboration": true,
- "organizationId": 2,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [
- {
- "component": "COLLABORATION_LICENSE",
- "quota": "1"
}, - {
- "component": "CONFERENCING",
- "quota": "50"
}, - {
- "component": "SOFTPHONE"
}, - {
- "component": "MITEAM_COLLABORATION_LICENSE",
- "quota": "50"
}, - {
- "component": "CLOUD_CRM_CONNECTOR"
}
], - "deviceLocations": [
- {
- "fullPathName": "Default location/Sweden"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899995100",
- "cesid": "+468999995100",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}
], - "mobileNumberPool": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123"
}
]
}Update organization Deprecated
Use this method to update an organization.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: required
| name required | string The name of the organization. |
| uniqueId | string A unique identifier for the organization. |
| locked | boolean Whether the organization is locked or not, either true or false. |
| domain | string The domain of the organization, a valid domain name, maximum 64 characters long, with syntax according to RFC883, but uppercase letters are not allowed. |
| reseller | string The reseller the organization belongs to, if omitted the reseller will be set to default. |
| backup | string The name of your backup of the organization template, mandatory field in POST, not to be used in PUT. The organization template backup needs to be uploaded to the management node prior to executing this method. |
| customerId | string An optional customer identity. |
| billingId | string An optional billing identity. |
| note | string An optional note. |
| defaultPhoneLine | string Value: "PRIMARY or SECONDARY" Which phone line should be the default on each user. If omitted, it is set to PRIMARY. |
| nodeId | string Node ID for the service node this organization resides on. |
| runWizard | boolean Set to true if organization wizard should be shown when admins login. The wizard will be shown if the wizard has not been completed. |
| collaboration | boolean Whether the organization has activated collaboration or not, either true or false. |
| cloudCrmConnectorWebHookUrl | string Webhook URL to the external integrated CRM system. |
| organizationId | integer <int32> The identity number of the organization. |
Array of objects (NumberRangeDTO) A list of the available number ranges for the organization. | |
Array of objects (LicenseDTO) A list of license quotas. | |
Array of objects (DeviceLocationDTO) A list of the available device locations for the organization | |
| countryCode | string Country code. Two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value.If the setting is omitted at PUT, the value will not change. |
Array of objects (MobileNumberPoolRangeDTO) A list of the available mobile number ranges for the organization. |
Responses
Request samples
- Payload
{- "uniqueId": "(telepo-id):-1uzpth0f59fq4-1l3ngbvtuk5le:foo.com",
- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "billingId": "+46899995000",
- "note": "Added some note",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": false,
- "organizationId": 2,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [
- {
- "component": "COLLABORATION_LICENSE",
- "quota": "1"
}, - {
- "component": "CONFERENCING",
- "quota": "50"
}, - {
- "component": "SOFTPHONE"
}, - {
- "component": "MITEAM_COLLABORATION_LICENSE",
- "quota": "50"
}, - {
- "component": "CLOUD_CRM_CONNECTOR"
}
], - "deviceLocations": [
- {
- "fullPathName": "Default location/Sweden"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm"
}, - {
- "fullPathName": "Default location/Sweden/Stockholm/Globen",
- "emergencyDestination": "+46899995100",
- "cesid": "+468999995100",
- "networks": [
- "10.123.123.123"
], - "disabledCodecs": [
- "AMR",
- "AMR-WB"
]
}
], - "mobileNumberPool": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46700123"
}
]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create organization Deprecated
Creates a new organization.
Note: When creating an organization via the API, organization administrators are not created automatically. They need to be created separately.
Note: If the node id is not specified, new organizations are by default placed on the service node with the least number of organizations. This will be the spare node, if that is not set in maintenance mode.
When creating organizations, it will take approx 30 s (data will propagate to the cluster) for the Management Node to synchronise data with the Service nodes. In other words, for a short time the Management node will not be aware that a new organization is present on the system.
Therefore, if you create an organization on a specific System node and then make immediate API-requests to it, for instance adding Users, they will fail. There is a way around the problem, you can include the Node ID in the API-request and subsequent requests as to ensure that the task is performed on the correct node even if the Management Node is not yet aware of the existence of the organization.
When creating an organization, one or more number ranges must be specified.
NOTE: This method is DEPRECATED since 5.2 and will be removed in future releases.
Authorizations:
path Parameters
| domain required | string The domain of the organization. |
query Parameters
| nodeid | string The node id of the service node to create the organization on. |
| load-template-quotas | boolean Whether or not license quotas should be preloaded from the backup. If not, license defaults are preloaded. |
Request Body schema: required
| name required | string The name of the organization. |
| uniqueId | string A unique identifier for the organization. |
| locked | boolean Whether the organization is locked or not, either true or false. |
| domain | string The domain of the organization, a valid domain name, maximum 64 characters long, with syntax according to RFC883, but uppercase letters are not allowed. |
| reseller | string The reseller the organization belongs to, if omitted the reseller will be set to default. |
| backup | string The name of your backup of the organization template, mandatory field in POST, not to be used in PUT. The organization template backup needs to be uploaded to the management node prior to executing this method. |
| customerId | string An optional customer identity. |
| billingId | string An optional billing identity. |
| note | string An optional note. |
| defaultPhoneLine | string Value: "PRIMARY or SECONDARY" Which phone line should be the default on each user. If omitted, it is set to PRIMARY. |
| nodeId | string Node ID for the service node this organization resides on. |
| runWizard | boolean Set to true if organization wizard should be shown when admins login. The wizard will be shown if the wizard has not been completed. |
| collaboration | boolean Whether the organization has activated collaboration or not, either true or false. |
| cloudCrmConnectorWebHookUrl | string Webhook URL to the external integrated CRM system. |
| organizationId | integer <int32> The identity number of the organization. |
Array of objects (NumberRangeDTO) A list of the available number ranges for the organization. | |
Array of objects (LicenseDTO) A list of license quotas. | |
Array of objects (DeviceLocationDTO) A list of the available device locations for the organization | |
| countryCode | string Country code. Two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value.If the setting is omitted at PUT, the value will not change. |
Array of objects (MobileNumberPoolRangeDTO) A list of the available mobile number ranges for the organization. |
Responses
Request samples
- Payload
{- "name": "Foo",
- "locked": false,
- "domain": "foo.com",
- "reseller": "CompReseller",
- "backup": "org_template",
- "billingId": "+46899995500",
- "defaultPhoneLine": "PRIMARY",
- "nodeId": "SITE_ONE",
- "runWizard": true,
- "numberRanges": [
- {
- "first": 100,
- "last": 199,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Incoming",
- "useForAutoProvisioning": true
}, - {
- "first": 500,
- "last": 599,
- "length": 3,
- "prefix": "+46899995",
- "sourceTags": "Outcoming",
- "useForAutoProvisioning": false
}
], - "licenses": [ ],
- "deviceLocations": [ ],
- "mobileNumberPool": [ ]
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Create service account for an organization
Create a new service account for an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: */*required
| name required | string A unique name of the service account. |
| secret required | string The secret of the service account. |
| secretExpires | string <date-time> The epoch time of the secret when expires. Default value is 1 year if not set. |
Responses
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Set the API scopes of the service account
Set the API scopes of the service account.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | integer <int64> The ID of the service account |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
[- "scope1",
- "scope2"
]Update SMG connection id
Use this method to update an organization.
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| id required | string The SMG connection id |
Request Body schema: */*required
| name required | string The name of the organization. |
| uniqueId | string A unique identifier for the organization. |
| locked | boolean Whether the organization is locked or not, either true or false. |
| domain | string The domain of the organization, a valid domain name, maximum 64 characters long, with syntax according to RFC883, but uppercase letters are not allowed. |
| reseller | string The reseller the organization belongs to, if omitted the reseller will be set to default. |
| backup | string The name of your backup of the organization template, mandatory field in POST, not to be used in PUT. The organization template backup needs to be uploaded to the management node prior to executing this method. |
| customerId | string An optional customer identity. |
| billingId | string An optional billing identity. |
| note | string An optional note. |
| defaultPhoneLine | string Value: "PRIMARY or SECONDARY" Which phone line should be the default on each user. If omitted, it is set to PRIMARY. |
| nodeId | string Node ID for the service node this organization resides on. |
| runWizard | boolean Set to true if organization wizard should be shown when admins login. The wizard will be shown if the wizard has not been completed. |
| collaboration | boolean Whether the organization has activated collaboration or not, either true or false. |
| cloudCrmConnectorWebHookUrl | string Webhook URL to the external integrated CRM system. |
| organizationId | integer <int32> The identity number of the organization. |
Array of objects (NumberRangeDTO) A list of the available number ranges for the organization. | |
Array of objects (LicenseDTO) A list of license quotas. | |
Array of objects (DeviceLocationDTO) A list of the available device locations for the organization | |
| countryCode | string Country code. Two uppercase letters (ISO 3166-1 alpha-2). A value appended with '*' indicates a default value. To clear the configured value, set a blank value.If the setting is omitted at PUT, the value will not change. |
Array of objects (MobileNumberPoolRangeDTO) A list of the available mobile number ranges for the organization. |
Responses
Request samples
- Payload
{ "uniqueId": "(telepo-id):-1uzpth0f59fq4-1l3ngbvtuk5le:foo.com", "name": "Foo", "locked": false, "domain": "foo.com", "reseller": "CompReseller", "billingId": "+46899995000", "note": "Added some note", "defaultPhoneLine": "PRIMARY", "nodeId": "SITE_ONE", "runWizard": false, "organizationId": 2, "numberRanges": [ { "first": 100, "last": 199, "length": 3, "prefix": "+46899995", "sourceTags": "Incoming", "useForAutoProvisioning": true }, { "first": 500, "last": 599, "length": 3, "prefix": "+46899995", "sourceTags": "Outcoming", "useForAutoProvisioning": false } ], "licenses": [ { "component": "COLLABORATION_LICENSE", "quota": "1" }, { "component": "CONFERENCING", "quota": "50" }, { "component": "SOFTPHONE" }, { "component": "MITEAM_COLLABORATION_LICENSE", "quota": "50" }, { "component": "CLOUD_CRM_CONNECTOR" } ], "deviceLocations": [ { "fullPathName": "Default location/Sweden" }, { "fullPathName": "Default location/Sweden/Stockholm" }, { "fullPathName": "Default location/Sweden/Stockholm/Globen", "emergencyDestination": "+46899995100", "cesid": "+468999995100", "networks": [ "10.123.123.123" ], "disabledCodecs": [ "AMR", "AMR-WB" ] } ], "mobileNumberPool": [ { "first": 100, "last": 199, "length": 3, "prefix": "+46700123" } ] }
Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Time Zone API is a group of methods to manage time zone(s) for an organization.
Use the Time Zone API to:
- Get time zone of an organization
- List all supported time zones
- Set time zone of an organization
The Working Hours API is a group of methods to manage working hour settings for an organization.
Use the Working Hours API to:
- Get working hours
- Set working hours
Get working hours
Retrieve working hours of an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Responses
Response samples
- 200
{- "days": [
- {
- "name": "Monday",
- "startOfDay": "09:00",
- "endOfDay": "16:00",
- "dayOfWeek": "MONDAY"
}, - {
- "name": "Tuesday",
- "startOfDay": "09:00",
- "endOfDay": "17:00",
- "dayOfWeek": "TUESDAY"
}, - {
- "name": "Wednesday",
- "startOfDay": "08:00",
- "endOfDay": "17:00",
- "dayOfWeek": "WEDNESDAY"
}, - {
- "name": "Thursday",
- "startOfDay": "09:00",
- "endOfDay": "18:00",
- "dayOfWeek": "THURSDAY"
}, - {
- "name": "Friday",
- "startOfDay": "08:00",
- "endOfDay": "14:00",
- "dayOfWeek": "FRIDAY"
}, - {
- "name": "Saturday",
- "dayOfWeek": "SATURDAY"
}, - {
- "name": "Sunday",
- "dayOfWeek": "SUNDAY"
}
]
}Update working hours
Update working hours of an organization.
Authorizations:
path Parameters
| domain required | string The domain of an organization |
Request Body schema: required
Array of objects (WorkingHourDayDto) A list of working days. |
Responses
Request samples
- Payload
{- "days": [
- {
- "startOfDay": "09:00",
- "endOfDay": "16:00",
- "dayOfWeek": "MONDAY"
}, - {
- "startOfDay": "09:00",
- "endOfDay": "17:00",
- "dayOfWeek": "TUESDAY"
}, - {
- "startOfDay": "08:00",
- "endOfDay": "17:00",
- "dayOfWeek": "WEDNESDAY"
}, - {
- "startOfDay": "09:00",
- "endOfDay": "18:00",
- "dayOfWeek": "THURSDAY"
}, - {
- "startOfDay": "08:00",
- "endOfDay": "14:00",
- "dayOfWeek": "FRIDAY"
}
]
}The Access Control API is used to manage access control settings for an organization. Access control settings comprise e.g. configuration of Two-Factor authentication.
Use the Access Control API to:
- Get access control configuration for an organization
- Update access control configuration for an organization
Get access control
Retrieve the access control settings for an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "orgAdminTwoFactorAuthentication": "ENABLED",
- "userTwoFactorAuthentication": "DISABLED",
- "defaultOrgAdminTwoFactorAuthentication": "REQUIRED",
- "defaultUserTwoFactorAuthentication": "ENABLED",
- "defaultTwoFactorAuthenticationEnforced": true,
- "identityProviders": "*",
- "regularCredentialsEnabled": true
}Update access control
Update the access control settings for an organization.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/jsonrequired
| orgAdminTwoFactorAuthentication required | string Enum: "UNSPECIFIED" "DISABLED" "ENABLED" "REQUIRED" Indicates if Two-Factor authentication is enabled, disabled or required for the organization administrators |
| userTwoFactorAuthentication required | string Enum: "UNSPECIFIED" "DISABLED" "ENABLED" "REQUIRED" Indicates if Two-Factor authentication is enabled, disabled or required for the users |
| regularCredentialsEnabled | boolean Indicates if users in this organization are allowed to login to Service Mediation Gateway services using regular credentials (default true) |
Responses
Request samples
- Payload
{- "orgAdminTwoFactorAuthentication": "ENABLED",
- "userTwoFactorAuthentication": "DISABLED",
- "identityProviders": "*",
- "regularCredentialsEnabled": true
}Response samples
- 400
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}Get 2FA status Deprecated
Use this method to check the two-factor authentication (2FA) setting of an organization. If true, the organization has two factor authentication enabled.
NOTE: This method is DEPRECATED.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
trueGet access control Deprecated
Retrieve the access control settings for an organization.
NOTE: This method is DEPRECATED.
Authorizations:
path Parameters
| domain required | string The organization domain |
Responses
Response samples
- 200
{- "twoFactorAuthenticationEnabled": true,
- "userTwoFactorAuthenticationEnabled": true,
- "regularCredentialsEnabled": true
}Update access control Deprecated
Update the access control settings for an organization.
NOTE: This method is DEPRECATED.
Authorizations:
path Parameters
| domain required | string The organization domain |
Request Body schema: application/json
| twoFactorAuthenticationEnabled required | boolean Indicates if Two-Factor authentication shall be enabled or not for the organization administrators |
| userTwoFactorAuthenticationEnabled required | boolean Indicates if Two-Factor authentication shall be enabled or not for the users |
| regularCredentialsEnabled | boolean Indicates if users in this organization are allowed to login to Service Mediation Gateway services using regular credentials (default true) |
Responses
Request samples
- Payload
{- "twoFactorAuthenticationEnabled": true,
- "userTwoFactorAuthenticationEnabled": true,
- "regularCredentialsEnabled": true
}Response samples
- 404
{- "field": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "warning": [
- {
- "fieldName": "user",
- "code": "user.does.not.exist",
- "description": "string",
- "name": "baduser@baddomain.com"
}
], - "generated-id": "string"
}The Deep Linking API can be used to generate a one-time use token that can login a user to a specific part of the user or administration portal.
Use the Deep Linking API to:
- Create a deep link to an organization's user list
- Create a deep link to a user's edit page
- Create a deep link to a function number's edit page
Link to function number edit
Create a one-time use token and url to access the target function number's edit page as the supplied organization administratorThe administrator must have rights administrate the target user
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
| targetdomain required | string The domain of the target function number |
| targetfnrid required | string The ID of the target function number |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}Link to user edit
Create a one-time use token and url to access the target user's edit page as the supplied administrator.The administrator must have rights to administrate the target user
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
| targetdomain required | string The domain of the target user |
| targetuser required | string The ID of the target user |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}Link to user list
Create a one-time use token and url to access the target organization's user list page as the supplied organization administrator. The user must be an administrator of the target organization
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
| targetdomain required | string The domain of the target organization |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}The Single Sign-On API can be used to generate a one-time use token that can login a user to the user portal.
The API can be used as part of a Single Sign-On enablement solution for organizations.Use the Single Sign-On API to:
- Create one-time use token to login a user to it's home page
- Create one-time use token to login an organization administrator to the organization's home page
- Create one-time use token to login a user to either it's home page or the organization's home page
Create login token
Create a one-time use token and url to login a user to either it's home page or the organization's home page based on if the user is an administrator or not.
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}Create administrator token
Create a one-time use token and url to log the supplied adminstrator into the organization's home page.
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}Create user token
Create a one-time use token and url to log the supplied user into the user home page.
Authorizations:
path Parameters
| domain required | string The domain of the user |
| user required | string The ID of the user |
Responses
Response samples
- 200
{- "oneTimeToken": "7.EDv2345RmNzQ1ZjU4Odjx",
- "expireTime": "2021-02-16T15:52:52.300Z"
}The User Tickets API is used to manage API tickets for a user
Use the User Tickets API to:
- Create a new API ticket
- Get an API ticket (only for superusers)
- List API tickets (only for superusers)
- Delete an API ticket
List tickets
Retrieve all API tickets created for a user. Only superuser is allowed to fetch tickets.
Authorizations:
path Parameters
| domain required | string The domain of the user to list API tickets for |
| user required | string The username of the user to list API tickets for |
Responses
Response samples
- 200
{- "userTicket": [
- {
- "name": "WEB_MEET",
- "token": "33.VDpiYTQ0MWE3MDgyODMzOWIy",
- "allowedApis": [
- "CONTACT",
- "CALLS",
- "USER"
]
}, - {
- "name": "SOFTPHONE_PLUS_API",
- "token": "33.VDoxZmY2Y2JkYTI1ZmFlOGIz",
- "allowedApis": [
- "CONTACT",
- "CALLS",
- "USER",
- "QUEUE_STATS",
- "EVENTCHANNEL",
- "SMS",
- "DISTRIBUTION_GROUP",
- "COMMUNICATION_LOG",
- "PERSONAL_CONTACTS",
- "CALL_RECORDING"
]
}
]
}Create ticket
There are two authentication approaches for this method. One approach is to use Password based ticket and the other one is to use Superuser Ticket.
For details on how to calculate the ticket string for the password based ticket, please see Using the API within the API reference.
Authorizations:
path Parameters
| domain required | string The domain of the user to create an API ticket for |
| user required | string The username of the user to create an API ticket for |
query Parameters
| api required | Array of strings One or more valid external APIs (e.g. ?api=CALLS&api=USER). |
| platform required | string Specifies which client that is making the request. The license validation is matched against the client value. It can have one of the following values: android, iphone, other |
| ver | string The version of the platform. Not required when the value of the platform is other |
| number | string The mobile number of the device that sends the request (applicable for platforms iphone and android). If stated, the number must be a mobile number of the user. |
| name | string A user defined name of the ticket, max 64 characters |
| expires | integer <int32> Expiration time of the ticket in seconds |
| deviceDisplayName | string A user defined name of the device |
Responses
Response samples
- 200
PASSWORD_BASED_TICKET
{- "expires": "2023-11-10T15:38:39.482+00:00",
- "name": "ALL_CALLS",
- "token": "2343.ZSDjndiJSDjksHj",
- "allowedApis": [
- "CALLS"
]
}Get ticket
The method returns information about an API ticket. Only superuser is allowed to fetch ticket information.
Authorizations:
path Parameters
| domain required | string The domain of the user to get an API ticket for |
| user required | string The username of the user to get an API ticket for |
| ticketName required | string The user defined name of the ticket to get |
Responses
Response samples
- 200
{- "name": "SOFTPHONE_PLUS_API",
- "token": "33.VDoxZmY2Y2JkYTI1ZmFlOGIz",
- "allowedApis": [
- "CONTACT",
- "CALLS",
- "USER",
- "QUEUE_STATS",
- "EVENTCHANNEL",
- "SMS",
- "DISTRIBUTION_GROUP",
- "COMMUNICATION_LOG",
- "PERSONAL_CONTACTS",
- "CALL_RECORDING"
]
}Delete ticket
If the ticket is deleted or revoked, it returns API ticket deleted successfully. The method is accessible through Password based ticket and Superuser Ticket.
Authorizations:
path Parameters
| domain required | string The domain of the user of the API ticket to delete |
| user required | string The username of the user of the API ticket to delete |
| ticketName required | string The user defined name of the ticket to delete |
Responses
The Switchboard API is used to manage switchboard number settings of an organization.
Use Switchboard API to:
- Get switchboard service group priority
- Get switchboard number settings of an organization
- Get switchboard number settings of a user
- Get switchboard number settings of a user group
- Update switchboard service group priority
- Update switchboard number settings of an organization
- Update switchboard number settings of a user
- Update switchboard number settings for a user group
- Delete switchboard number settings of an organization
- Delete switchboard number settings for a user
- Delete switchboard number settings for a user group
Note that when updating, settings that are not provided are removed.
Get usergroup switchboard number settings
Read switchboard number settings of a usergroup
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Responses
Response samples
- 200
{- "number": "+13344642",
- "defaultCid": true
}Update usergroup switchboard number settings
Update switchboard number settings for a user group
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| groupId required | string The name of the user group |
Request Body schema: application/json
| number | string The switchboard number. |
| defaultCid | boolean True if the switchboard number is used as default caller ID. Default is false. |
Responses
Request samples
- Payload
{- "number": "+13344642",
- "defaultCid": true
}Update organization switchboard number settings
Update switchboard number settings of an organization
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema:
| number | string The switchboard number. |
| defaultCid | boolean True if the switchboard number is used as default caller ID. Default is false. |
Responses
Request samples
- Payload
{- "number": "+13344642",
- "defaultCid": true
}Get user switchboard number settings
Read switchboard number settings of a user
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Responses
Response samples
- 200
{- "number": "+13344642",
- "defaultCid": true
}Update user switchboard number settings
Update switchboard number settings of a user
Authorizations:
path Parameters
| domain required | string The domain of the organization |
| user required | string The username of the user |
Request Body schema: application/json
| number | string The switchboard number. |
| defaultCid | boolean True if the switchboard number is used as default caller ID. Default is false. |
Responses
Request samples
- Payload
{- "number": "+13344642",
- "defaultCid": true
}Update service group priority
Update switchboard service group priority
Authorizations:
path Parameters
| domain required | string The domain of the organization |
Request Body schema: application/json
| groups | Array of strings User groups. The groups are listed in the priority order. |
Responses
Request samples
- Payload
{- "groups": "sales"
}