logo
API docs by Redocly

SuperVoIP (1.0.0)

Download OpenAPI specification:

Authorization: Add a header in the following format to every request:

Name: Authorization

Value: Bearer <token>

Replace <token> with your API token.

Sample request:

curl -H \"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ...\" https://restapi.supervoip.pl/api/customers/me

Asterisk

Asterisk actions.

/api/asterisk/do_call

Authorizations:
apiKey
Request Body schema: application/json
sip
string <iri-reference>
toNumber
string
callId
string

Responses

Request samples

Content type
application/json
{
  • "sip": "/api/sips/1250000",
  • "toNumber": "700100200",
  • "callId": ""
}

/api/asterisk/do_call_remote

Authorizations:
apiKey
Request Body schema: application/json
sip
string <iri-reference>
sip2
string <iri-reference>
first_call
string
second_call
string
presentationNumber
string
presentationNumber2
string
duration
integer

Maximum call duration in minutes

callId
string
waitingTime
integer

Time in seconds before the second call is established

Responses

Request samples

Content type
application/json
{
  • "sip": "/api/sips/1250000",
  • "sip2": "/api/sips/1260000",
  • "first_call": "700100200",
  • "second_call": "800102102",
  • "presentationNumber": "500200300",
  • "presentationNumber2": "600700800",
  • "duration": "2",
  • "callId": "",
  • "waitingTime": "1"
}

/api/asterisk/reset_queue

Authorizations:
apiKey
Request Body schema: application/json
queue
string <iri-reference>

Responses

Request samples

Content type
application/json
{
  • "queue": "/api/ivr_queues/1"
}

/api/asterisk/do_hangup_by_call_id

Authorizations:
apiKey
Request Body schema: application/json
callId
string

Responses

Request samples

Content type
application/json
{
  • "callId": "1758870281.11543750"
}

IncomingCall

Incoming calls billing.

Incoming calls

Authorizations:
apiKey
query Parameters
SIP.number
string
SIP.number[]
Array of strings
calledNumber
string
calledNumber[]
Array of strings
disposition
string
disposition[]
Array of strings
directionClass.id
string
directionClass.id[]
Array of strings
callerNumber
string
callerNumber[]
Array of strings
SIP.SIPGroup.id
string
SIP.SIPGroup.id[]
Array of strings
uniqueId
string
uniqueId[]
Array of strings
exists[note]
boolean
callStart[before]
string
callStart[strictly_before]
string
callStart[after]
string
callStart[strictly_after]
string
order[callStart]
string
Enum: "asc" "desc"
order[calledNumber]
string
Enum: "asc" "desc"
order[duration]
string
Enum: "asc" "desc"
order[conversationDuration]
string
Enum: "asc" "desc"
action
string
duration[between]
string
duration[gt]
string
duration[gte]
string
duration[lt]
string
duration[lte]
string
conversationDuration[between]
string
conversationDuration[gt]
string
conversationDuration[gte]
string
conversationDuration[lt]
string
conversationDuration[lte]
string
pickedUp
boolean
isMobile
boolean
queue
string
queue[]
Array of strings
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

IncomingCalls statistics

Authorizations:
apiKey
query Parameters
SIP.number
string
SIP.number[]
Array of strings
calledNumber
string
calledNumber[]
Array of strings
disposition
string
disposition[]
Array of strings
directionClass.id
string
directionClass.id[]
Array of strings
callerNumber
string
callerNumber[]
Array of strings
SIP.SIPGroup.id
string
SIP.SIPGroup.id[]
Array of strings
exists[note]
boolean
callStart[before]
string
callStart[strictly_before]
string
callStart[after]
string
callStart[strictly_after]
string
order[callStart]
string
Enum: "asc" "desc"
order[calledNumber]
string
Enum: "asc" "desc"
order[duration]
string
Enum: "asc" "desc"
order[conversationDuration]
string
Enum: "asc" "desc"
action
string
duration[between]
string
duration[gt]
string
duration[gte]
string
duration[lt]
string
duration[lte]
string
conversationDuration[between]
string
conversationDuration[gt]
string
conversationDuration[gte]
string
conversationDuration[lt]
string
conversationDuration[lte]
string
pickedUp
boolean
isMobile
boolean
queue
string
queue[]
Array of strings
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "page": {
    },
  • "total": {
    }
}

OutgoingCall

Outgoing calls billing.

Outgoing calls

Authorizations:
apiKey
query Parameters
SIP.number
string
SIP.number[]
Array of strings
calledNumber
string
calledNumber[]
Array of strings
disposition
string
disposition[]
Array of strings
priceGroup.country.id
string
priceGroup.country.id[]
Array of strings
directionClass.id
string
directionClass.id[]
Array of strings
callerNumber
string
callerNumber[]
Array of strings
SIP.SIPGroup.id
string
SIP.SIPGroup.id[]
Array of strings
uniqueId
string
uniqueId[]
Array of strings
exists[note]
boolean
answeredAutomatically
boolean
callStart[before]
string
callStart[strictly_before]
string
callStart[after]
string
callStart[strictly_after]
string
duration[between]
string
duration[gt]
string
duration[gte]
string
duration[lt]
string
duration[lte]
string
order[callStart]
string
Enum: "asc" "desc"
order[calledNumber]
string
Enum: "asc" "desc"
order[duration]
string
Enum: "asc" "desc"
order[cost]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

OutgoingCalls statistics

Authorizations:
apiKey
query Parameters
SIP.number
string
SIP.number[]
Array of strings
calledNumber
string
calledNumber[]
Array of strings
disposition
string
disposition[]
Array of strings
priceGroup.country.id
string
priceGroup.country.id[]
Array of strings
directionClass.id
string
directionClass.id[]
Array of strings
callerNumber
string
callerNumber[]
Array of strings
SIP.SIPGroup.id
string
SIP.SIPGroup.id[]
Array of strings
exists[note]
boolean
answeredAutomatically
boolean
callStart[before]
string
callStart[strictly_before]
string
callStart[after]
string
callStart[strictly_after]
string
duration[between]
string
duration[gt]
string
duration[gte]
string
duration[lt]
string
duration[lte]
string
order[callStart]
string
Enum: "asc" "desc"
order[calledNumber]
string
Enum: "asc" "desc"
order[duration]
string
Enum: "asc" "desc"
order[cost]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "page": {
    },
  • "total": {
    }
}

Sms

Sms billing.

SMS billing

Authorizations:
apiKey
query Parameters
fromNumber
string
fromNumber[]
Array of strings
toNumber
string
toNumber[]
Array of strings
type
string
type[]
Array of strings
status
string
status[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
order[createdAt]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Record

Records of incoming and outgoing calls.

Recorded calls

Authorizations:
apiKey
query Parameters
type
string
type[]
Array of strings
fromNumber
string
fromNumber[]
Array of strings
toNumber
string
toNumber[]
Array of strings
sipNumber
string
sipNumber[]
Array of strings
date[before]
string
date[strictly_before]
string
date[after]
string
date[strictly_after]
string
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Downloads recorded calls in ZIP format

Authorizations:
apiKey
query Parameters
type
string
type[]
Array of strings
fromNumber
string
fromNumber[]
Array of strings
toNumber
string
toNumber[]
Array of strings
sipNumber
string
sipNumber[]
Array of strings
date[before]
string
date[strictly_before]
string
date[after]
string
date[strictly_after]
string
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Downloads a single recorded call

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "string",
  • "duration": 0,
  • "fileName": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "fromNumber": "string",
  • "toNumber": "string",
  • "sipNumber": "string",
  • "type": "string"
}

ConferenceRoom

Conference rooms

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Country

Countries

A list of available countries

Authorizations:
apiKey
query Parameters
name
string
sms
boolean

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Customer

Customer data.

Retrieves the currently logged in Customer

Authorizations:
apiKey

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "isCompany": true,
  • "nip": "string",
  • "companyName": "string",
  • "companyCountry": {
    },
  • "addresses": [
    ],
  • "isSMSVerified": true,
  • "phoneMobile": "string",
  • "phoneTechnical": "string",
  • "emailTechnical": "string",
  • "emailFax": "string",
  • "SIPs": [
    ],
  • "IVR": {
    },
  • "office": {
    },
  • "serviceType": "prepaid",
  • "SIPGroups": [
    ],
  • "contactUrls": [
    ],
  • "exposeContacts": true,
  • "musicOnHold": {
    },
  • "businessType": "business",
  • "voiceMessagesLanguage": "string",
  • "dataChangeRequest": {
    },
  • "web2Call": true,
  • "web2CallToken": "string",
  • "traceOut": true,
  • "traceOutTime": 0,
  • "traceIn": true,
  • "traceInTime": 0,
  • "presentationManagement": true,
  • "invoiceByEmail": true,
  • "invoiceEmails": [
    ],
  • "invoiceLanguage": {
    },
  • "proformaNumber": "string",
  • "groupInvoices": true,
  • "groupedInvoiceTitle": "Doładowanie konta SuperVoIP",
  • "lowBalanceNotificationThreshold": "string",
  • "lowBalanceNotificationEmail": [
    ],
  • "lowBalanceNotificationPhoneNumber": "string",
  • "negativeBalanceNotificationPhoneNumber": "string",
  • "incomingForeignChannels": 0,
  • "queueManagement": true,
  • "queueKey": "string",
  • "queuePreviewPassword": "string",
  • "queueAgentsPassword": "string",
  • "internalNumbersManagement": true,
  • "invoiceCurrency": "PLN",
  • "taxStrategy": "normal",
  • "creditLimit": "string",
  • "incomingCallRecording": {
    },
  • "conferences": true,
  • "webhooks": [
    ],
  • "soapApi": true,
  • "soapApiKey": "string",
  • "soapApiAuthenticationMethod": "ip",
  • "soapApiIPs": [
    ],
  • "soapApiNotificationUrl": "string",
  • "outgoingCallRecording": {
    },
  • "disallowAnonymous": true,
  • "blockNumbers": "string",
  • "outgoingCallMonitoring": true,
  • "voicemail": true,
  • "voicemailRecognition": true,
  • "sipTrunk": true,
  • "smsService": {
    },
  • "numberCountries": [
    ],
  • "hasForeignNumber": true,
  • "faxService": true,
  • "serviceBundle": {
    },
  • "serviceBundleRequest": {
    },
  • "freeSecondsTotal": 0,
  • "freeSecondsUsed": 0,
  • "serviceBundleLock": true,
  • "suppressSync": true,
  • "accountBalance": "string",
  • "bundlePrice": [
    ],
  • "accountTopUpRequest": "/entity/1",
  • "faxNumber": "string",
  • "regon": "string",
  • "recurringAccountTopUp": {
    },
  • "overrideSIPLimit": true,
  • "voipNumberLock": true,
  • "allowDelayAccountCharge": true,
  • "firstSynchronizationComplete": true,
  • "pesel": "string",
  • "chatGpt": true,
  • "chatGptInstanceLimit": 0,
  • "foreignNumberPresentation": true,
  • "newCustomer": true,
  • "webPhone": true,
  • "isSynchronizing": true,
  • "billingAddress": "/entity/1",
  • "activeVerificationFile": {
    },
  • "pendingServiceRequests": {
    },
  • "daysUntilAccountRemoval": 0,
  • "primaryUserId": 0,
  • "voipNumberTypes": [
    ],
  • "incomingCallsSyncInProgress": true,
  • "outgoingCallsSyncInProgress": true,
  • "incomingCallsSyncQueued": true,
  • "outgoingCallsSyncQueued": true,
  • "hasNumber": true,
  • "hasFreePeriodForLandlineDomesticNumbers": true,
  • "hasOutgoingFaxService": true,
  • "hadNumber": true,
  • "smsSyncQueued": true,
  • "smsSyncInProgress": true
}

Media

Customer media files.

Creates a new media file

Authorizations:
apiKey
Request Body schema: multipart/form-data
file
string <binary>
name
string
category
Array of strings
Items Enum: "ivr" "musicOnHold" "queue"

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fileName": "string",
  • "musicOnHoldMedia": {
    },
  • "fileType": "string",
  • "ivrMedia": "/entity/1",
  • "type": "ownFile",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "category": [
    ],
  • "ttsMessage": "string",
  • "name": "string",
  • "queueMedia": {
    },
  • "ivrScenarios": {
    }
}

Media files

Authorizations:
apiKey
query Parameters
type
string
Enum: "ownFile" "textToSpeech"
type[]
Array of strings
Items Enum: "ownFile" "textToSpeech"
category
string
Enum: "ivr" "musicOnHold" "queue"
category[]
Array of strings
Items Enum: "ivr" "musicOnHold" "queue"
usedInIvrScenario
boolean
usedInIvrScenario[]
Array of booleans
fileName
string
order[fileName]
string
Enum: "asc" "desc"
order[duration]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

A single media file

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fileName": "string",
  • "musicOnHoldMedia": {
    },
  • "fileType": "string",
  • "ivrMedia": "/entity/1",
  • "type": "ownFile",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "category": [
    ],
  • "ttsMessage": "string",
  • "name": "string",
  • "queueMedia": {
    },
  • "ivrScenarios": {
    }
}

Removes a media file

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Modifies a media file

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated Media resource

category
Array of strings
ttsMessage
string
name
string

Responses

Request samples

Content type
{
  • "category": [
    ],
  • "ttsMessage": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fileName": "string",
  • "musicOnHoldMedia": {
    },
  • "fileType": "string",
  • "ivrMedia": "/entity/1",
  • "type": "ownFile",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "category": [
    ],
  • "ttsMessage": "string",
  • "name": "string",
  • "queueMedia": {
    },
  • "ivrScenarios": {
    }
}

Downloads a media file

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fileName": "string",
  • "musicOnHoldMedia": {
    },
  • "fileType": "string",
  • "ivrMedia": "/entity/1",
  • "type": "ownFile",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "duration": 0,
  • "category": [
    ],
  • "ttsMessage": "string",
  • "name": "string",
  • "queueMedia": {
    },
  • "ivrScenarios": {
    }
}

Sip

Customer SIP accounts.

SIP numbers

Authorizations:
apiKey
query Parameters
SIPGroup
string
SIPGroup[]
Array of strings
name
string
loggedIn
boolean
loggedIn[]
Array of booleans
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a SIP number

Authorizations:
apiKey
Request Body schema:

The new Sip resource

customer
string or null <iri-reference>
SIPGroup
string or null <iri-reference>
firstName
string or null
lastName
string or null
description
string or null
recordOutgoing
boolean
recordInternal
boolean
incomingCallQueueLimit
integer
outgoingCallTimeLimit
integer
outgoingCallDayLimit
string or null
natSupport
boolean
srtpEnabled
boolean
G722
boolean
PCMU
boolean
PCMA
boolean
GSM
boolean
iLBC
boolean
emergencyNumber
string or null <iri-reference>
outgoingCallLimit
integer
presentationNumber
string or null <iri-reference>
presentationNumberSms
string or null <iri-reference>
presentationNumberDomestic
string or null <iri-reference>
presentationNumberForeign
string or null <iri-reference>
presentNumberOnRedirect
boolean

This actually means DON'T show number on redirect.

presentationNumberSmsRelay
boolean
presentationNumberSms2Way
boolean
presentationNumberEog
string or null <iri-reference>
eog
boolean
monitor
string or null
voicemailRecognition
string or null
trunk
boolean
trunkAuthType
string
trunkIP
string
trunkPresentation
string
outgoingCallPresentation
boolean
outgoingCallTimeLimitEnabled
boolean
enableOutgoingDomestic
boolean
enableOutgoingForeign
boolean
enableOutgoingHelpline
boolean
enableOutgoingForeignPremium
boolean
enableOutgoingSpecial
boolean
enableOutgoingEmergency
boolean
enableOutgoingForeignWithoutPrefix
boolean
officeAccess
boolean
incomingCallQueueEnabled
boolean
outgoingCallsAnnounceMedia
string or null <iri-reference>
outgoingCallsAnnounce
boolean
foreignPresentationNumber
string or null <iri-reference>
costLimit
string or null

Responses

Request samples

Content type
{
  • "customer": "/entity/1",
  • "SIPGroup": "/entity/1",
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": "/entity/1",
  • "outgoingCallLimit": 0,
  • "presentationNumber": "/entity/1",
  • "presentationNumberSms": "/entity/1",
  • "presentationNumberDomestic": "/entity/1",
  • "presentationNumberForeign": "/entity/1",
  • "presentNumberOnRedirect": true,
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": "/entity/1",
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": "/entity/1",
  • "costLimit": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "voipNumbers": [
    ],
  • "SIPGroup": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "loginStatuses": [
    ],
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": {
    },
  • "outgoingCallLimit": 0,
  • "presentationNumber": {
    },
  • "presentationNumberSms": {
    },
  • "presentationNumberDomestic": {
    },
  • "presentationNumberForeign": {
    },
  • "presentNumberOnRedirect": true,
  • "internalNumber": {
    },
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": {
    },
  • "defaultOutgoingCallLimit": 0,
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "callStatus": "free",
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": {
    },
  • "costLimit": "string",
  • "number": 0,
  • "loggedIn": true,
  • "presentation": "string",
  • "defaultPresentationNumber": {
    },
  • "defaultPresentationNumberSms": {
    },
  • "deviceName": "string",
  • "pricePerMonth": 0
}

A single SIP number

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "voipNumbers": [
    ],
  • "SIPGroup": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "loginStatuses": [
    ],
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": {
    },
  • "outgoingCallLimit": 0,
  • "presentationNumber": {
    },
  • "presentationNumberSms": {
    },
  • "presentationNumberDomestic": {
    },
  • "presentationNumberForeign": {
    },
  • "presentNumberOnRedirect": true,
  • "internalNumber": {
    },
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": {
    },
  • "defaultOutgoingCallLimit": 0,
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "callStatus": "free",
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": {
    },
  • "costLimit": "string",
  • "number": 0,
  • "loggedIn": true,
  • "presentation": "string",
  • "queues": {
    },
  • "defaultPresentationNumber": {
    },
  • "defaultPresentationNumberSms": {
    },
  • "deviceName": "string"
}

Modifies a SIP number

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated Sip resource

SIPGroup
string or null <iri-reference>
firstName
string or null
lastName
string or null
description
string or null
recordOutgoing
boolean
recordInternal
boolean
incomingCallQueueLimit
integer
outgoingCallTimeLimit
integer
outgoingCallDayLimit
string or null
natSupport
boolean
srtpEnabled
boolean
G722
boolean
PCMU
boolean
PCMA
boolean
GSM
boolean
iLBC
boolean
emergencyNumber
string or null <iri-reference>
outgoingCallLimit
integer
presentationNumber
string or null <iri-reference>
presentationNumberSms
string or null <iri-reference>
presentationNumberDomestic
string or null <iri-reference>
presentationNumberForeign
string or null <iri-reference>
presentNumberOnRedirect
boolean

This actually means DON'T show number on redirect.

presentationNumberSmsRelay
boolean
presentationNumberSms2Way
boolean
presentationNumberEog
string or null <iri-reference>
eog
boolean
monitor
string or null
voicemailRecognition
string or null
trunk
boolean
trunkAuthType
string
trunkIP
string
trunkPresentation
string
outgoingCallPresentation
boolean
outgoingCallTimeLimitEnabled
boolean
enableOutgoingDomestic
boolean
enableOutgoingForeign
boolean
enableOutgoingHelpline
boolean
enableOutgoingForeignPremium
boolean
enableOutgoingSpecial
boolean
enableOutgoingEmergency
boolean
enableOutgoingForeignWithoutPrefix
boolean
officeAccess
boolean
incomingCallQueueEnabled
boolean
outgoingCallsAnnounceMedia
string or null <iri-reference>
outgoingCallsAnnounce
boolean
foreignPresentationNumber
string or null <iri-reference>
costLimit
string or null

Responses

Request samples

Content type
{
  • "SIPGroup": "/entity/1",
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": "/entity/1",
  • "outgoingCallLimit": 0,
  • "presentationNumber": "/entity/1",
  • "presentationNumberSms": "/entity/1",
  • "presentationNumberDomestic": "/entity/1",
  • "presentationNumberForeign": "/entity/1",
  • "presentNumberOnRedirect": true,
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": "/entity/1",
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": "/entity/1",
  • "costLimit": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "voipNumbers": [
    ],
  • "SIPGroup": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "loginStatuses": [
    ],
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": {
    },
  • "outgoingCallLimit": 0,
  • "presentationNumber": {
    },
  • "presentationNumberSms": {
    },
  • "presentationNumberDomestic": {
    },
  • "presentationNumberForeign": {
    },
  • "presentNumberOnRedirect": true,
  • "internalNumber": {
    },
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": {
    },
  • "defaultOutgoingCallLimit": 0,
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "callStatus": "free",
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": {
    },
  • "costLimit": "string",
  • "number": 0,
  • "loggedIn": true,
  • "presentation": "string",
  • "defaultPresentationNumber": {
    },
  • "defaultPresentationNumberSms": {
    },
  • "deviceName": "string",
  • "pricePerMonth": 0
}

Generates a SIP password and sends it via e-mail

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "voipNumbers": [
    ],
  • "SIPGroup": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "description": "string",
  • "recordOutgoing": true,
  • "recordInternal": true,
  • "loginStatuses": [
    ],
  • "incomingCallQueueLimit": 0,
  • "outgoingCallTimeLimit": 0,
  • "outgoingCallDayLimit": "string",
  • "natSupport": true,
  • "srtpEnabled": true,
  • "G722": true,
  • "PCMU": true,
  • "PCMA": true,
  • "GSM": true,
  • "iLBC": true,
  • "emergencyNumber": {
    },
  • "outgoingCallLimit": 0,
  • "presentationNumber": {
    },
  • "presentationNumberSms": {
    },
  • "presentationNumberDomestic": {
    },
  • "presentationNumberForeign": {
    },
  • "presentNumberOnRedirect": true,
  • "internalNumber": {
    },
  • "presentationNumberSmsRelay": true,
  • "presentationNumberSms2Way": true,
  • "presentationNumberEog": {
    },
  • "defaultOutgoingCallLimit": 0,
  • "eog": true,
  • "monitor": "string",
  • "voicemailRecognition": "string",
  • "trunk": true,
  • "trunkAuthType": "string",
  • "trunkIP": "string",
  • "trunkPresentation": "string",
  • "outgoingCallPresentation": true,
  • "outgoingCallTimeLimitEnabled": true,
  • "enableOutgoingDomestic": true,
  • "enableOutgoingForeign": true,
  • "enableOutgoingHelpline": true,
  • "enableOutgoingForeignPremium": true,
  • "enableOutgoingSpecial": true,
  • "enableOutgoingEmergency": true,
  • "enableOutgoingForeignWithoutPrefix": true,
  • "callStatus": "free",
  • "officeAccess": true,
  • "incomingCallQueueEnabled": true,
  • "outgoingCallsAnnounceMedia": "/entity/1",
  • "outgoingCallsAnnounce": true,
  • "foreignPresentationNumber": {
    },
  • "costLimit": "string",
  • "number": 0,
  • "loggedIn": true,
  • "presentation": "string",
  • "defaultPresentationNumber": {
    },
  • "defaultPresentationNumberSms": {
    },
  • "deviceName": "string",
  • "pricePerMonth": 0
}

VoipNumber

Customer voip numbers.

Voip numbers

Authorizations:
apiKey
query Parameters
smsEnabled
boolean
sip
string
sip[]
Array of strings
sipPresentation
string
sipPresentation[]
Array of strings
number.country
string
number.country[]
Array of strings
localConnectionSIPs.id
integer
localConnectionSIPs.id[]
Array of integers
activityMonitoring
boolean
number.mobile
boolean
recordIncoming
boolean
number.onlySms
boolean
number.mobile[]
Array of booleans
phoneNumber
string
exists[ivrScenario]
boolean
exists[queue]
boolean
exists[conferenceRoom]
boolean
exists[voicemail]
boolean
exists[findMe]
boolean
exists[conditionalRedirect]
boolean
exists[redirect]
boolean
exists[localConnection]
boolean
numberType
string
numberType[]
Array of strings
type
string
type[]
Array of strings
order[phoneNumber]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a voip number

Authorizations:
apiKey
Request Body schema:

The new VoipNumber resource

number
string <iri-reference>
sip
string <iri-reference>
firstSubscriptionPeriod
string or null
Enum: "monthly" "quarterly" "semi-annual" "annual"

Required for mobile numbers, null otherwise

Responses

Request samples

Content type
{
  • "number": "/entity/1",
  • "sip": "/entity/1",
  • "firstSubscriptionPeriod": "monthly"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "internalNumbers": [
    ],
  • "smsRedirect": {
    },
  • "musicOnHoldGroup": 0,
  • "ivrScenario": {
    },
  • "activityMonitoring": true,
  • "activityMonitoringLimit": 0,
  • "title": "string",
  • "available": true,
  • "queue": {
    },
  • "queueTimeLimit": 60,
  • "queueTtsLanguage": "en",
  • "queueCallerIdExtras": "name",
  • "queueAddPolishPrefix": true,
  • "queuePrioritizeContacts": true,
  • "queueMusicOnHoldGroup": 0,
  • "recordIncoming": true,
  • "voicemail": true,
  • "voicemailSIPs": [
    ],
  • "voicemailMusicOnHoldGroup": 0,
  • "voicemailConditions": [
    ],
  • "voicemailIvrMedia": "/entity/1",
  • "voicemailNoAnswerLimit": 0,
  • "voicemailDefaultEmail": true,
  • "voicemailEmails": [
    ],
  • "findMe": true,
  • "findMeSIPs": [
    ],
  • "findMeTimeLimit": 0,
  • "findMeNumbers": [
    ],
  • "conditionalRedirect": true,
  • "conditionalRedirectSIPs": [
    ],
  • "conditionalRedirectCallerIdExtras": "name",
  • "conditionalRedirectAddPolishPrefix": true,
  • "conditionalRedirectMusicOnHold": true,
  • "conditionalRedirectMusicOnHoldGroup": 0,
  • "conditionalRedirectConditions": [
    ],
  • "conditionalRedirectNoAnswerLimit": 0,
  • "conditionalRedirectNumber": "string",
  • "conditionalRedirectPresentation": "incoming",
  • "conditionalRedirectIvrMedia": "/entity/1",
  • "redirect": true,
  • "redirectNumber": "string",
  • "redirectPresentation": "incoming",
  • "redirectMusicOnHold": true,
  • "redirectMusicOnHoldGroup": 0,
  • "redirectIvrMedia": "/entity/1",
  • "localConnection": true,
  • "localConnectionType": "sip",
  • "localConnectionMusicOnHoldGroup": 0,
  • "localConnectionCallerIdExtras": "name",
  • "localConnectionSIPs": [
    ],
  • "localConnectionAddPolishPrefix": true,
  • "localConnectionMultiSips": [
    ],
  • "conferenceRoom": {
    },
  • "address": "/entity/1",
  • "incomingCallLimit": 0,
  • "availabilityMonitoring": true,
  • "availabilityMonitoringSms": "string",
  • "availabilityMonitoringEmail": "string",
  • "availabilityMonitoringSmsEnabled": true,
  • "availabilityMonitoringEmailEnabled": true,
  • "conditionalRedirectSIP": {
    },
  • "redirectSIP": {
    },
  • "firstSubscriptionPeriod": "monthly",
  • "allowNonEogPresentation": true,
  • "mobile": true,
  • "canSendForeignSms": true,
  • "phoneNumber": "string",
  • "sms": "string",
  • "smsEnabled": true,
  • "country": {
    },
  • "regionName": "string",
  • "foreign": true,
  • "canBeTransformedIntoFax": true,
  • "netto": 0,
  • "brutto": 0,
  • "recordOutgoing": true,
  • "numberType": "string",
  • "onlySms": true,
  • "inRange": true,
  • "paidUntil": "2019-08-24T14:15:22Z"
}

A single voip number

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "internalNumbers": [
    ],
  • "smsRedirect": {
    },
  • "musicOnHoldGroup": 0,
  • "ivrScenario": {
    },
  • "activityMonitoring": true,
  • "activityMonitoringLimit": 0,
  • "title": "string",
  • "available": true,
  • "queue": {
    },
  • "queueTimeLimit": 60,
  • "queueTtsLanguage": "en",
  • "queueCallerIdExtras": "name",
  • "queueAddPolishPrefix": true,
  • "queuePrioritizeContacts": true,
  • "queueMusicOnHoldGroup": 0,
  • "recordIncoming": true,
  • "voicemail": true,
  • "voicemailSIPs": [
    ],
  • "voicemailMusicOnHoldGroup": 0,
  • "voicemailConditions": [
    ],
  • "voicemailIvrMedia": {
    },
  • "voicemailNoAnswerLimit": 0,
  • "voicemailDefaultEmail": true,
  • "voicemailEmails": [
    ],
  • "findMe": true,
  • "findMeSIPs": [
    ],
  • "findMeTimeLimit": 0,
  • "findMeNumbers": [
    ],
  • "conditionalRedirect": true,
  • "conditionalRedirectSIPs": [
    ],
  • "conditionalRedirectCallerIdExtras": "name",
  • "conditionalRedirectAddPolishPrefix": true,
  • "conditionalRedirectMusicOnHold": true,
  • "conditionalRedirectMusicOnHoldGroup": 0,
  • "conditionalRedirectConditions": [
    ],
  • "conditionalRedirectNoAnswerLimit": 0,
  • "conditionalRedirectNumber": "string",
  • "conditionalRedirectPresentation": "incoming",
  • "conditionalRedirectIvrMedia": {
    },
  • "redirect": true,
  • "redirectNumber": "string",
  • "redirectPresentation": "incoming",
  • "redirectMusicOnHold": true,
  • "redirectMusicOnHoldGroup": 0,
  • "redirectIvrMedia": {
    },
  • "localConnection": true,
  • "localConnectionType": "sip",
  • "localConnectionMusicOnHoldGroup": 0,
  • "localConnectionCallerIdExtras": "name",
  • "localConnectionSIPs": [
    ],
  • "localConnectionAddPolishPrefix": true,
  • "localConnectionMultiSips": [
    ],
  • "conferenceRoom": {
    },
  • "address": "/entity/1",
  • "incomingCallLimit": 0,
  • "availabilityMonitoring": true,
  • "availabilityMonitoringSms": "string",
  • "availabilityMonitoringEmail": "string",
  • "availabilityMonitoringSmsEnabled": true,
  • "availabilityMonitoringEmailEnabled": true,
  • "conditionalRedirectSIP": {
    },
  • "redirectSIP": {
    },
  • "firstSubscriptionPeriod": "string",
  • "allowNonEogPresentation": true,
  • "mobile": true,
  • "canSendForeignSms": true,
  • "phoneNumber": "string",
  • "sms": "string",
  • "smsEnabled": true,
  • "country": {
    },
  • "regionName": "string",
  • "foreign": true,
  • "canBeTransformedIntoFax": true,
  • "netto": 0,
  • "brutto": 0,
  • "recordOutgoing": true,
  • "numberType": "string",
  • "onlySms": true,
  • "inRange": true,
  • "paidUntil": "2019-08-24T14:15:22Z"
}

Modifies a voip number

VoipNumber configuration request payload:

  • Parameters values:

    • localConnectionCallerIdExtras: null, name, addressbook
    • localConnectionMultiSips.conditions: BUSY, NO_ANSWER, UNAVAILABLE
    • redirectPresentation|: incoming, redirect
    • conditionalRedirectPresentation: incoming, redirect
    • conditionalRedirectCallerIdExtras: null, name, addressbook
    • conditionalRedirectConditions: BUSY, NO_ANSWER, UNAVAILABLE
    • voicemailConditions: BUSY, NO_ANSWER, UNAVAILABLE
    • queueTtsLanguage: en, fr, es, de, pl, pl2, arek, ru, ua, it`
    • queueCallerIdExtras: null, name, addressbook

  • Local connection:

    • SIPs ring at the same time:

      {
  "localConnection": true,
  "localConnectionType": "sip",
  "localConnectionSIPs": [
    "/api/sips/1250000",
    "/api/sips/1250001"
  ],
  "localConnectionAddPolishPrefix": true,
  "localConnectionCallerIdExtras": null
}

    • SIPs ring in order:

      {
  "localConnection": true,
  "localConnectionType": "multiSip",
  "localConnectionAddPolishPrefix": true,
  "localConnectionCallerIdExtras": null,
  "localConnectionMultiSips": [
    {
      "conditions": ["BUSY"],
      "duration": 25,
      "sips": [
        "/api/sips/1250000",
        "/api/sips/1250001",
      ]
    },
    {
      "conditions": ["BUSY", "NO_ANSWER"],
      "duration": 20,
      "sips": [
        "/api/sips/1250005"
      ]
    }
  ]
}

  • Redirect:

    {
  "redirect": true,
  "recordIncoming": false,
  "redirectNumber": "48800500300",
  "redirectSIP: "/api/sips/1250001",
  "redirectPresentation": "incoming",
  "allowNonEogPresentation": false,
  "redirectIvrMedia": "/api/ivr_media/5"
}

redirectIvrMedia is nullable

  • Conditional redirect:

    {
  "conditionalRedirect": true,
  "recordIncoming": false,
  "conditionalRedirectSIPs": [
    "/api/sips/1250001",
    "/api/sips/1250002"
  ],
  "conditionalRedirectCallerIdExtras": null,
  "conditionalRedirectConditions": ["BUSY", "NO_ANSWER"],
  "conditionalRedirectAddPolishPrefix": true,
  "conditionalRedirectNumber": "48800500300",
  "conditionalRedirectSIP": "/api/sips/1250001",
  "conditionalRedirectPresentation": "incoming",
  "allowNonEogPresentation": false,
  "conditionalRedirectIvrMedia": "/api/ivr_media/5"
}

conditionalRedirectIvrMedia is nullable

  • Voicemail:

    {
  "voicemail": true,
  "recordIncoming": false,
  "voicemailSIPs": [
    "/api/sips/1250001",
    "/api/sips/1250002"
  ],
  "voicemailConditions": ["BUSY", "UNAVAILABLE"],
  "voicemailNoAnswerLimit": 5,
  "voicemailIvrMedia": "/api/ivr_media/5",
  "voicemailDefaultEmail": false,
  "voicemailEmails": ["email1@supervoip.pl", "email2@supervoip.pl]
}

    voicemailIvrMedia is nullable

  • Queue:

    {
  "recordIncoming": false,
  "queue": "/api/ivr_queues/100",
  "queueTimeLimit": 60,
  "queueTtsLanguage": "en",
  "queueCallerIdExtras": null,
  "queueAddPolishPrefix": true,
  "queuePrioritizeContacts": false
}

    queueTimeLimit is in seconds

  • IVR:

    {
  "ivrScenario": "/api/ivr_scenarios/34"
}

  • Conferences:

    {
  "conferenceRoom": "/api/conference_rooms/5"
}
Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated VoipNumber resource

sip
string <iri-reference>
musicOnHoldGroup
integer or null
ivrScenario
string or null <iri-reference>
activityMonitoring
boolean
activityMonitoringLimit
integer
title
string
queue
string or null <iri-reference>
queueTimeLimit
integer
Enum: 60 180 300 600 900 1200 1800 3600
queueTtsLanguage
string
Enum: "en" "fr" "es" "de" "pl" "pl2" "arek" "ru" "it"
queueCallerIdExtras
string or null
Enum: "name" "queuename" "addressbook"
queueAddPolishPrefix
boolean
queuePrioritizeContacts
boolean
queueMusicOnHoldGroup
integer
recordIncoming
boolean
voicemail
boolean
voicemailSIPs
Array of strings <iri-reference> [ items <iri-reference > ]
voicemailMusicOnHoldGroup
integer or null
voicemailConditions
Array of strings
voicemailIvrMedia
string or null <iri-reference>
voicemailNoAnswerLimit
integer
voicemailDefaultEmail
boolean
voicemailEmails
Array of strings
findMe
boolean
findMeSIPs
Array of strings <iri-reference> [ items <iri-reference > ]
findMeTimeLimit
integer
Array of objects (FindMeNumber:jsonld-voip-write)
conditionalRedirect
boolean
conditionalRedirectSIPs
Array of strings <iri-reference> [ items <iri-reference > ]
conditionalRedirectCallerIdExtras
string or null
Enum: "name" "addressbook"
conditionalRedirectAddPolishPrefix
boolean
conditionalRedirectMusicOnHold
boolean
conditionalRedirectMusicOnHoldGroup
integer
conditionalRedirectConditions
Array of strings
conditionalRedirectNoAnswerLimit
integer
conditionalRedirectNumber
string
conditionalRedirectPresentation
string
Enum: "incoming" "redirect"
conditionalRedirectIvrMedia
string or null <iri-reference>
redirect
boolean
redirectNumber
string
redirectPresentation
string
Enum: "incoming" "redirect"
redirectMusicOnHold
boolean
redirectMusicOnHoldGroup
integer
redirectIvrMedia
string or null <iri-reference>
localConnection
boolean
localConnectionType
string
Enum: "sip" "multiSip"
localConnectionMusicOnHoldGroup
integer or null
localConnectionCallerIdExtras
string or null
Enum: "name" "addressbook"
localConnectionSIPs
Array of strings <iri-reference> [ items <iri-reference > ]
localConnectionAddPolishPrefix
boolean
Array of objects (LocalConnectionMultiSip:jsonld-voip-write)
conferenceRoom
string or null <iri-reference>
address
string or null <iri-reference>
availabilityMonitoring
boolean
availabilityMonitoringSms
string
availabilityMonitoringEmail
availabilityMonitoringSmsEnabled
boolean
availabilityMonitoringEmailEnabled
boolean
conditionalRedirectSIP
string or null <iri-reference>
redirectSIP
string or null <iri-reference>
allowNonEogPresentation
boolean

Responses

Request samples

Content type
{
  • "sip": "/entity/1",
  • "musicOnHoldGroup": 0,
  • "ivrScenario": "/entity/1",
  • "activityMonitoring": true,
  • "activityMonitoringLimit": 0,
  • "title": "string",
  • "queue": "/entity/1",
  • "queueTimeLimit": 60,
  • "queueTtsLanguage": "en",
  • "queueCallerIdExtras": "name",
  • "queueAddPolishPrefix": true,
  • "queuePrioritizeContacts": true,
  • "queueMusicOnHoldGroup": 0,
  • "recordIncoming": true,
  • "voicemail": true,
  • "voicemailSIPs": [
    ],
  • "voicemailMusicOnHoldGroup": 0,
  • "voicemailConditions": [
    ],
  • "voicemailIvrMedia": "/entity/1",
  • "voicemailNoAnswerLimit": 0,
  • "voicemailDefaultEmail": true,
  • "voicemailEmails": [
    ],
  • "findMe": true,
  • "findMeSIPs": [
    ],
  • "findMeTimeLimit": 0,
  • "findMeNumbers": [
    ],
  • "conditionalRedirect": true,
  • "conditionalRedirectSIPs": [
    ],
  • "conditionalRedirectCallerIdExtras": "name",
  • "conditionalRedirectAddPolishPrefix": true,
  • "conditionalRedirectMusicOnHold": true,
  • "conditionalRedirectMusicOnHoldGroup": 0,
  • "conditionalRedirectConditions": [
    ],
  • "conditionalRedirectNoAnswerLimit": 0,
  • "conditionalRedirectNumber": "string",
  • "conditionalRedirectPresentation": "incoming",
  • "conditionalRedirectIvrMedia": "/entity/1",
  • "redirect": true,
  • "redirectNumber": "string",
  • "redirectPresentation": "incoming",
  • "redirectMusicOnHold": true,
  • "redirectMusicOnHoldGroup": 0,
  • "redirectIvrMedia": "/entity/1",
  • "localConnection": true,
  • "localConnectionType": "sip",
  • "localConnectionMusicOnHoldGroup": 0,
  • "localConnectionCallerIdExtras": "name",
  • "localConnectionSIPs": [
    ],
  • "localConnectionAddPolishPrefix": true,
  • "localConnectionMultiSips": [
    ],
  • "conferenceRoom": "/entity/1",
  • "address": "/entity/1",
  • "availabilityMonitoring": true,
  • "availabilityMonitoringSms": "string",
  • "availabilityMonitoringEmail": "string",
  • "availabilityMonitoringSmsEnabled": true,
  • "availabilityMonitoringEmailEnabled": true,
  • "conditionalRedirectSIP": "/entity/1",
  • "redirectSIP": "/entity/1",
  • "allowNonEogPresentation": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "internalNumbers": [
    ],
  • "smsRedirect": {
    },
  • "musicOnHoldGroup": 0,
  • "ivrScenario": {
    },
  • "activityMonitoring": true,
  • "activityMonitoringLimit": 0,
  • "title": "string",
  • "available": true,
  • "queue": {
    },
  • "queueTimeLimit": 60,
  • "queueTtsLanguage": "en",
  • "queueCallerIdExtras": "name",
  • "queueAddPolishPrefix": true,
  • "queuePrioritizeContacts": true,
  • "queueMusicOnHoldGroup": 0,
  • "recordIncoming": true,
  • "voicemail": true,
  • "voicemailSIPs": [
    ],
  • "voicemailMusicOnHoldGroup": 0,
  • "voicemailConditions": [
    ],
  • "voicemailIvrMedia": "/entity/1",
  • "voicemailNoAnswerLimit": 0,
  • "voicemailDefaultEmail": true,
  • "voicemailEmails": [
    ],
  • "findMe": true,
  • "findMeSIPs": [
    ],
  • "findMeTimeLimit": 0,
  • "findMeNumbers": [
    ],
  • "conditionalRedirect": true,
  • "conditionalRedirectSIPs": [
    ],
  • "conditionalRedirectCallerIdExtras": "name",
  • "conditionalRedirectAddPolishPrefix": true,
  • "conditionalRedirectMusicOnHold": true,
  • "conditionalRedirectMusicOnHoldGroup": 0,
  • "conditionalRedirectConditions": [
    ],
  • "conditionalRedirectNoAnswerLimit": 0,
  • "conditionalRedirectNumber": "string",
  • "conditionalRedirectPresentation": "incoming",
  • "conditionalRedirectIvrMedia": "/entity/1",
  • "redirect": true,
  • "redirectNumber": "string",
  • "redirectPresentation": "incoming",
  • "redirectMusicOnHold": true,
  • "redirectMusicOnHoldGroup": 0,
  • "redirectIvrMedia": "/entity/1",
  • "localConnection": true,
  • "localConnectionType": "sip",
  • "localConnectionMusicOnHoldGroup": 0,
  • "localConnectionCallerIdExtras": "name",
  • "localConnectionSIPs": [
    ],
  • "localConnectionAddPolishPrefix": true,
  • "localConnectionMultiSips": [
    ],
  • "conferenceRoom": {
    },
  • "address": "/entity/1",
  • "incomingCallLimit": 0,
  • "availabilityMonitoring": true,
  • "availabilityMonitoringSms": "string",
  • "availabilityMonitoringEmail": "string",
  • "availabilityMonitoringSmsEnabled": true,
  • "availabilityMonitoringEmailEnabled": true,
  • "conditionalRedirectSIP": {
    },
  • "redirectSIP": {
    },
  • "firstSubscriptionPeriod": "monthly",
  • "allowNonEogPresentation": true,
  • "mobile": true,
  • "canSendForeignSms": true,
  • "phoneNumber": "string",
  • "sms": "string",
  • "smsEnabled": true,
  • "country": {
    },
  • "regionName": "string",
  • "foreign": true,
  • "canBeTransformedIntoFax": true,
  • "netto": 0,
  • "brutto": 0,
  • "recordOutgoing": true,
  • "numberType": "string",
  • "onlySms": true,
  • "inRange": true,
  • "paidUntil": "2019-08-24T14:15:22Z"
}

IvrScenario

IVR scenarios.

IVR scenarios

Authorizations:
apiKey
query Parameters
order[name]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[voipNumbers]
string
Enum: "asc" "desc"
order[elementCount]
string
Enum: "asc" "desc"
order[price]
string
Enum: "asc" "desc"
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates an IVR scenario

Authorizations:
apiKey
Request Body schema:

The new IvrScenario resource

name
string
callRecording
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "callRecording": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "voipNumbers": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "elementCount": 0,
  • "price": 0
}

A single IVR scenario

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "voipNumbers": [
    ],
  • "elements": [
    ],
  • "callRecording": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "elementCount": 0,
  • "price": 0
}

Modifies an IVR scenario

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrScenario resource

name
string
callRecording
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "callRecording": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "voipNumbers": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "elementCount": 0,
  • "price": 0
}

Removes an IVR scenario

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Clones an existing IVR scenario

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema: application/ld+json
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "name": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "voipNumbers": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "elementCount": 0,
  • "price": 0
}

IvrTable

IVR data tables used in check table conditions.

IVR tables

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a IvrTable resource.

Authorizations:
apiKey
Request Body schema:

The new IvrTable resource

name
string
customer
string <iri-reference>

Responses

Request samples

Content type
{
  • "name": "string",
  • "customer": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

A single IVR table

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "tableRows": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z"
}

Modifies an IVR table

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrTable resource

name
string

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

Removes an IVR table and its rows

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrTableRow

IVR data tables rows, used by specific IVR tables.

Creates an IVR table row

Authorizations:
apiKey
Request Body schema:

The new IvrTableRow resource

ivrTable
string <iri-reference>
column1
string
column2
string
column3
string
column4
string

Responses

Request samples

Content type
{
  • "ivrTable": "/entity/1",
  • "column1": "string",
  • "column2": "string",
  • "column3": "string",
  • "column4": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "column1": "string",
  • "column2": "string",
  • "column3": "string",
  • "column4": "string"
}

Modifies an IVR table row

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrTableRow resource

column1
string
column2
string
column3
string
column4
string

Responses

Request samples

Content type
{
  • "column1": "string",
  • "column2": "string",
  • "column3": "string",
  • "column4": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "column1": "string",
  • "column2": "string",
  • "column3": "string",
  • "column4": "string"
}

Removes an IVR table row

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrAuthPin

PINs used in IVR authentication conditions.

Creates an IVR authentication pin

Authorizations:
apiKey
Request Body schema:

The new IvrAuthPin resource

customer
string <iri-reference>
name
string
muted
boolean
pin
string

Responses

Request samples

Content type
{
  • "customer": "/entity/1",
  • "name": "string",
  • "muted": true,
  • "pin": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "muted": true,
  • "pin": "string"
}

Modifies an IVR authentication pin

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrAuthPin resource

name
string
muted
boolean
pin
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "muted": true,
  • "pin": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "muted": true,
  • "pin": "string"
}

Removes an IVR auth pin

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrAuthPhone

Phone numbers used in IVR authentication conditions.

Creates an IVR authentication phone

Authorizations:
apiKey
Request Body schema:

The new IvrAuthPhone resource

customer
string <iri-reference>
number
string
pin
string
muted
boolean

Responses

Request samples

Content type
{
  • "customer": "/entity/1",
  • "number": "string",
  • "pin": "string",
  • "muted": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "number": "string",
  • "pin": "string",
  • "muted": true
}

Modifies an IVR authentication phone

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrAuthPhone resource

number
string
pin
string
muted
boolean

Responses

Request samples

Content type
{
  • "number": "string",
  • "pin": "string",
  • "muted": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "number": "string",
  • "pin": "string",
  • "muted": true
}

Removes an IVR authentication phone

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrAiInstance

ChatGPT instances used in IVR ChatGPT actions.

IVR AI instances

Authorizations:
apiKey
query Parameters
order[name]
string
Enum: "asc" "desc"
order[emails]
string
Enum: "asc" "desc"
name
string
name[]
Array of strings
emails
string
emails[]
Array of strings
order[phoneNumber]
string
Enum: "asc" "desc"
phoneNumber
string
phoneNumber[]
Array of strings
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates an IVR AI instance

Authorizations:
apiKey
Request Body schema:

The new IvrAiInstance resource

name
string
redirectWords
Array of strings
stopWords
Array of strings
redirectPhoneNumber
string or null
sendEmail
boolean
emails
Array of strings
emailPeriod
string
customer
string <iri-reference>
afterStopWordsMessage
string
beforeRedirectMessage
string
rememberConversations
boolean
rememberConversationsTimeLimit
integer
model
string
redirectSip
string or null <iri-reference>
exitAndRedirect
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "redirectWords": [
    ],
  • "stopWords": [
    ],
  • "redirectPhoneNumber": "string",
  • "sendEmail": true,
  • "emails": [
    ],
  • "emailPeriod": "string",
  • "customer": "/entity/1",
  • "afterStopWordsMessage": "string",
  • "beforeRedirectMessage": "string",
  • "rememberConversations": true,
  • "rememberConversationsTimeLimit": 0,
  • "model": "string",
  • "redirectSip": "/entity/1",
  • "exitAndRedirect": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "redirectWords": [
    ],
  • "stopWords": [
    ],
  • "redirectPhoneNumber": "string",
  • "sendEmail": true,
  • "emails": [
    ],
  • "emailPeriod": "string",
  • "sources": [
    ],
  • "afterStopWordsMessage": "string",
  • "beforeRedirectMessage": "string",
  • "rememberConversations": true,
  • "rememberConversationsTimeLimit": 0,
  • "model": "string",
  • "redirectSip": "/entity/1",
  • "exitAndRedirect": true,
  • "usedInIvr": true,
  • "ivrScenarios": {
    }
}

A single IVR AI instance

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "redirectWords": [
    ],
  • "stopWords": [
    ],
  • "redirectPhoneNumber": "string",
  • "sendEmail": true,
  • "emails": [
    ],
  • "emailPeriod": "string",
  • "sources": [
    ],
  • "afterStopWordsMessage": "string",
  • "beforeRedirectMessage": "string",
  • "rememberConversations": true,
  • "rememberConversationsTimeLimit": 0,
  • "model": "string",
  • "redirectSip": "/entity/1",
  • "exitAndRedirect": true,
  • "usedInIvr": true,
  • "ivrScenarios": {
    }
}

Modifies an IVR AI instance

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrAiInstance resource

name
string
redirectWords
Array of strings
stopWords
Array of strings
redirectPhoneNumber
string or null
sendEmail
boolean
emails
Array of strings
emailPeriod
string
afterStopWordsMessage
string
beforeRedirectMessage
string
rememberConversations
boolean
rememberConversationsTimeLimit
integer
model
string
redirectSip
string or null <iri-reference>
exitAndRedirect
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "redirectWords": [
    ],
  • "stopWords": [
    ],
  • "redirectPhoneNumber": "string",
  • "sendEmail": true,
  • "emails": [
    ],
  • "emailPeriod": "string",
  • "afterStopWordsMessage": "string",
  • "beforeRedirectMessage": "string",
  • "rememberConversations": true,
  • "rememberConversationsTimeLimit": 0,
  • "model": "string",
  • "redirectSip": "/entity/1",
  • "exitAndRedirect": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "redirectWords": [
    ],
  • "stopWords": [
    ],
  • "redirectPhoneNumber": "string",
  • "sendEmail": true,
  • "emails": [
    ],
  • "emailPeriod": "string",
  • "sources": [
    ],
  • "afterStopWordsMessage": "string",
  • "beforeRedirectMessage": "string",
  • "rememberConversations": true,
  • "rememberConversationsTimeLimit": 0,
  • "model": "string",
  • "redirectSip": "/entity/1",
  • "exitAndRedirect": true,
  • "usedInIvr": true,
  • "ivrScenarios": {
    }
}

Removes an IVR AI instance

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrAiSource

Data sources used in IvrAiInstances.

Creates an IVR AI source

Authorizations:
apiKey
Request Body schema:

The new IvrAiSource resource

name
string
type
string
source
string
instance
string <iri-reference>
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "source": "string",
  • "instance": "/entity/1",
  • "enabled": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "type": "string",
  • "source": "string",
  • "enabled": true
}

A single IVR AI source

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "type": "string",
  • "source": "string",
  • "enabled": true
}

Modifies an IVR AI source

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrAiSource resource

name
string
type
string
source
string
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "string",
  • "source": "string",
  • "enabled": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "type": "string",
  • "source": "string",
  • "enabled": true
}

Removes an IVR AI source

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionCallRecording

Creates a Call Recording IVR action

Authorizations:
apiKey
Request Body schema:

The new IvrActionCallRecording resource

enabled
boolean
scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>
position
integer
nextPosition
integer
object (IVRElementRate:jsonld)
editable
boolean or null

Responses

Request samples

Content type
{
  • "enabled": true,
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1",
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "position": 0,
  • "nextPosition": 0,
  • "rate": {
    },
  • "editable": true
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes a Call Recording IVR action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionChatGpt

Creates a Chat GPT IVR action

Authorizations:
apiKey
Request Body schema:

The new IvrActionChatGpt resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "instance": "/entity/1",
  • "ttsVoice": "/entity/1",
  • "queryText": "string",
  • "queryMedia": "/entity/1",
  • "queryVariable": 0,
  • "repeatQueryText": "string",
  • "repeatQueryMedia": "/entity/1",
  • "quitOnRecognizedWords": true,
  • "redirectAfter": true,
  • "enabled": true,
  • "final": true,
  • "language": "string",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies a Chat GPT IVR action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionChatGpt resource

instance
string <iri-reference>
ttsVoice
string <iri-reference>
queryText
string or null
queryMedia
string or null <iri-reference>
queryVariable
integer or null
repeatQueryText
string or null
repeatQueryMedia
string or null <iri-reference>
quitOnRecognizedWords
boolean
redirectAfter
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "instance": "/entity/1",
  • "ttsVoice": "/entity/1",
  • "queryText": "string",
  • "queryMedia": "/entity/1",
  • "queryVariable": 0,
  • "repeatQueryText": "string",
  • "repeatQueryMedia": "/entity/1",
  • "quitOnRecognizedWords": true,
  • "redirectAfter": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "instance": "/entity/1",
  • "ttsVoice": "/entity/1",
  • "queryText": "string",
  • "queryMedia": "/entity/1",
  • "queryVariable": 0,
  • "repeatQueryText": "string",
  • "repeatQueryMedia": "/entity/1",
  • "quitOnRecognizedWords": true,
  • "redirectAfter": true,
  • "enabled": true,
  • "final": true,
  • "language": "string",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes a Chat GPT IVR action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionConnectToSip

Creates an IVR connect to SIP action

Authorizations:
apiKey
Request Body schema:

The new IvrActionConnectToSip resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "SIPs": [
    ],
  • "timeLimit": 0,
  • "useMusicOnHold": true,
  • "musicOnHoldGroup": 0,
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Modifies an IVR connect to SIP action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionConnectToSip resource

SIPs
Array of strings <iri-reference> [ items <iri-reference > ]
timeLimit
integer
useMusicOnHold
boolean
musicOnHoldGroup
integer
callerIdExtras
string or null
Enum: "callerid" "name" "queuename" "addressbook"
addPolishPrefix
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "SIPs": [
    ],
  • "timeLimit": 0,
  • "useMusicOnHold": true,
  • "musicOnHoldGroup": 0,
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "SIPs": [
    ],
  • "timeLimit": 0,
  • "useMusicOnHold": true,
  • "musicOnHoldGroup": 0,
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Removes an IVR connect to SIP action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionEnterNumbers

Creates an IVR enter numbers action

Authorizations:
apiKey
Request Body schema:

The new IvrActionEnterNumbers resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "ivrMedia": "/entity/1",
  • "numberCount": 0,
  • "variableId": 0,
  • "showInCallerId": true,
  • "enabled": true,
  • "final": true,
  • "media": "/entity/1",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR enter numbers action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionEnterNumbers resource

ivrMedia
string or null <iri-reference>
numberCount
integer
variableId
integer
showInCallerId
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "ivrMedia": "/entity/1",
  • "numberCount": 0,
  • "variableId": 0,
  • "showInCallerId": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "ivrMedia": "/entity/1",
  • "numberCount": 0,
  • "variableId": 0,
  • "showInCallerId": true,
  • "enabled": true,
  • "final": true,
  • "media": "/entity/1",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR enter numbers action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionGoTo

Creates an IVR go-to action

Authorizations:
apiKey
Request Body schema:

The new IvrActionGoTo resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "target": "/entity/1",
  • "ivrMedia": "/entity/1",
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Modifies an IVR go-to action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionGoTo resource

target
string or null <iri-reference>
ivrMedia
string or null <iri-reference>
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "target": "/entity/1",
  • "ivrMedia": "/entity/1",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "target": "/entity/1",
  • "ivrMedia": "/entity/1",
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Removes an IVR go-to action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionMenuOption

Options for specific IVR menu actions.

Creates an IVR menu option

Authorizations:
apiKey
Request Body schema:

The new IvrActionMenuOption resource

menu
string or null <iri-reference>
option
integer
description
string
scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "menu": "/entity/1",
  • "option": 0,
  • "description": "string",
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "menu": "/entity/1",
  • "option": 0,
  • "description": "string",
  • "enabled": true,
  • "final": true,
  • "nextOption": "/entity/1",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR menu option

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionMenuOption resource

menu
string or null <iri-reference>
option
integer
description
string
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "menu": "/entity/1",
  • "option": 0,
  • "description": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "menu": "/entity/1",
  • "option": 0,
  • "description": "string",
  • "enabled": true,
  • "final": true,
  • "nextOption": "/entity/1",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR menu option

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionMenu

Creates an IVR menu action

Authorizations:
apiKey
Request Body schema:

The new IvrActionMenu resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "welcomeMessage": "/entity/1",
  • "broadcastInCallerId": true,
  • "allowInternalNumbers": true,
  • "wrongChoice": true,
  • "wrongChoiceMessage": "/entity/1",
  • "wrongChoiceGoTo": "/entity/1",
  • "repeatCount": 0,
  • "endingMessage": "/entity/1",
  • "options": [
    ],
  • "postAction": "string",
  • "actionConnectToSIPSips": [
    ],
  • "actionConnectToSIPMusicOnHold": true,
  • "actionConnectToSIPCallerIdExtras": "string",
  • "actionConnectToSIPTimeout": 0,
  • "actionRedirectNumber": "string",
  • "actionRedirectTimeout": 0,
  • "actionRedirectUseVariable": true,
  • "actionRedirectVariable": 0,
  • "actionQueue": "/entity/1",
  • "actionQueueTimeLimit": 0,
  • "actionQueueTtsLanguage": "string",
  • "actionQueueAddPolishPrefix": true,
  • "actionQueueCallerIdExtras": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR menu action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionMenu resource

welcomeMessage
string or null <iri-reference>
broadcastInCallerId
boolean
allowInternalNumbers
boolean
wrongChoice
boolean
wrongChoiceMessage
string or null <iri-reference>
wrongChoiceGoTo
string or null <iri-reference>
repeatCount
integer
endingMessage
string or null <iri-reference>
postAction
string
actionConnectToSIPSips
Array of strings <iri-reference> [ items <iri-reference > ]
actionConnectToSIPMusicOnHold
boolean
actionConnectToSIPCallerIdExtras
string or null
actionConnectToSIPTimeout
integer
actionRedirectNumber
string
actionRedirectTimeout
integer
actionRedirectUseVariable
boolean
actionRedirectVariable
integer
actionQueue
string or null <iri-reference>
actionQueueTimeLimit
integer
actionQueueTtsLanguage
string
actionQueueAddPolishPrefix
boolean
actionQueueCallerIdExtras
string or null
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "welcomeMessage": "/entity/1",
  • "broadcastInCallerId": true,
  • "allowInternalNumbers": true,
  • "wrongChoice": true,
  • "wrongChoiceMessage": "/entity/1",
  • "wrongChoiceGoTo": "/entity/1",
  • "repeatCount": 0,
  • "endingMessage": "/entity/1",
  • "postAction": "string",
  • "actionConnectToSIPSips": [
    ],
  • "actionConnectToSIPMusicOnHold": true,
  • "actionConnectToSIPCallerIdExtras": "string",
  • "actionConnectToSIPTimeout": 0,
  • "actionRedirectNumber": "string",
  • "actionRedirectTimeout": 0,
  • "actionRedirectUseVariable": true,
  • "actionRedirectVariable": 0,
  • "actionQueue": "/entity/1",
  • "actionQueueTimeLimit": 0,
  • "actionQueueTtsLanguage": "string",
  • "actionQueueAddPolishPrefix": true,
  • "actionQueueCallerIdExtras": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "welcomeMessage": "/entity/1",
  • "broadcastInCallerId": true,
  • "allowInternalNumbers": true,
  • "wrongChoice": true,
  • "wrongChoiceMessage": "/entity/1",
  • "wrongChoiceGoTo": "/entity/1",
  • "repeatCount": 0,
  • "endingMessage": "/entity/1",
  • "options": [
    ],
  • "postAction": "string",
  • "actionConnectToSIPSips": [
    ],
  • "actionConnectToSIPMusicOnHold": true,
  • "actionConnectToSIPCallerIdExtras": "string",
  • "actionConnectToSIPTimeout": 0,
  • "actionRedirectNumber": "string",
  • "actionRedirectTimeout": 0,
  • "actionRedirectUseVariable": true,
  • "actionRedirectVariable": 0,
  • "actionQueue": "/entity/1",
  • "actionQueueTimeLimit": 0,
  • "actionQueueTtsLanguage": "string",
  • "actionQueueAddPolishPrefix": true,
  • "actionQueueCallerIdExtras": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR menu action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Creates an IVR open hyperlink action

Authorizations:
apiKey
Request Body schema:

The new IvrActionOpenHyperlink resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "url": "string",
  • "ignoreInvalidCertificates": true,
  • "outputVariable": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR open hyperlink action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionOpenHyperlink resource

url
ignoreInvalidCertificates
boolean
outputVariable
integer or null
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "url": "string",
  • "ignoreInvalidCertificates": true,
  • "outputVariable": 0,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "url": "string",
  • "ignoreInvalidCertificates": true,
  • "outputVariable": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR open hyperlink action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionPlayMessage

Creates an IVR play message action

Authorizations:
apiKey
Request Body schema:

The new IvrActionPlayMessage resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "ivrMedia": "/entity/1",
  • "url": "string",
  • "enabled": true,
  • "final": true,
  • "media": {
    },
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR play message action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionPlayMessage resource

ivrMedia
string or null <iri-reference>
url
string or null
http://schema.org/url
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "ivrMedia": "/entity/1",
  • "url": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "ivrMedia": "/entity/1",
  • "url": "string",
  • "enabled": true,
  • "final": true,
  • "media": {
    },
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR play message action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionQueue

Creates an IVR queue action

Authorizations:
apiKey
Request Body schema:

The new IvrActionQueue resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "queue": "/entity/1",
  • "timeLimit": 60,
  • "ttsLanguage": "en",
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "prioritizeContacts": true,
  • "useAgentsPriority": true,
  • "agentsPriorityMin": 0,
  • "agentsPriorityMax": 0,
  • "musicOnHoldGroup": 0,
  • "dynamicAgentPriority": 1,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Modifies an IVR queue action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionQueue resource

queue
string or null <iri-reference>
timeLimit
integer
Enum: 60 180 300 600 900 1200 1800 3600
ttsLanguage
string
Enum: "en" "fr" "es" "de" "pl" "pl2" "arek" "ru" "it"
callerIdExtras
string or null
Enum: "callerid" "name" "queuename" "addressbook"
addPolishPrefix
boolean
prioritizeContacts
boolean
useAgentsPriority
boolean
agentsPriorityMin
integer
agentsPriorityMax
integer
musicOnHoldGroup
integer
dynamicAgentPriority
string or null
Enum: 1 2 3 4 5 6
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "queue": "/entity/1",
  • "timeLimit": 60,
  • "ttsLanguage": "en",
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "prioritizeContacts": true,
  • "useAgentsPriority": true,
  • "agentsPriorityMin": 0,
  • "agentsPriorityMax": 0,
  • "musicOnHoldGroup": 0,
  • "dynamicAgentPriority": 1,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "queue": "/entity/1",
  • "timeLimit": 60,
  • "ttsLanguage": "en",
  • "callerIdExtras": "callerid",
  • "addPolishPrefix": true,
  • "prioritizeContacts": true,
  • "useAgentsPriority": true,
  • "agentsPriorityMin": 0,
  • "agentsPriorityMax": 0,
  • "musicOnHoldGroup": 0,
  • "dynamicAgentPriority": 1,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Removes an IVR queue action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionReadText

Creates an IVR read text action

Authorizations:
apiKey
Request Body schema:

The new IvrActionReadText resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "text": "string",
  • "voice": "/entity/1",
  • "enabled": true,
  • "language": "string",
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR read text action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionReadText resource

text
string or null
voice
string or null <iri-reference>
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "text": "string",
  • "voice": "/entity/1",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "text": "string",
  • "voice": "/entity/1",
  • "enabled": true,
  • "language": "string",
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR read text action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionRedirect

Creates an IVR redirect action

Authorizations:
apiKey
Request Body schema:

The new IvrActionRedirect resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "phoneNumber": "string",
  • "waitingTime": 0,
  • "presentation": "incoming",
  • "useVariable": true,
  • "variable": 0,
  • "useTimeLimit": true,
  • "timeLimit": 0,
  • "redirectMessage": "/entity/1",
  • "sip": "/entity/1",
  • "allowNonEogPresentation": true,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Replaces an IVR redirect action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionRedirect resource

phoneNumber
string
waitingTime
integer
presentation
string
Enum: "incoming" "redirect"
useVariable
boolean
variable
integer
useTimeLimit
boolean
timeLimit
integer
redirectMessage
string or null <iri-reference>
sip
string or null <iri-reference>
allowNonEogPresentation
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "phoneNumber": "string",
  • "waitingTime": 0,
  • "presentation": "incoming",
  • "useVariable": true,
  • "variable": 0,
  • "useTimeLimit": true,
  • "timeLimit": 0,
  • "redirectMessage": "/entity/1",
  • "sip": "/entity/1",
  • "allowNonEogPresentation": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "phoneNumber": "string",
  • "waitingTime": 0,
  • "presentation": "incoming",
  • "useVariable": true,
  • "variable": 0,
  • "useTimeLimit": true,
  • "timeLimit": 0,
  • "redirectMessage": "/entity/1",
  • "sip": "/entity/1",
  • "allowNonEogPresentation": true,
  • "enabled": true,
  • "final": true,
  • "allowedNext": [
    ],
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true
}

Removes an IVR redirect action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSendEmail

Creates an IVR send e-mail action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSendEmail resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "email": "string",
  • "title": "string",
  • "message": "string",
  • "sendToMainEmail": true,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR send e-mail action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSendEmail resource

email
title
string
message
string
sendToMainEmail
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "email": "string",
  • "title": "string",
  • "message": "string",
  • "sendToMainEmail": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "email": "string",
  • "title": "string",
  • "message": "string",
  • "sendToMainEmail": true,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR send e-mail action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSendSms

Creates an IVR send SMS action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSendSms resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "number": "string",
  • "message": "string",
  • "useGateway": true,
  • "use2way": true,
  • "voipNumber": "/entity/1",
  • "sender": {
    },
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR send SMS action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSendSms resource

number
string
message
string
useGateway
boolean
use2way
boolean
voipNumber
string or null <iri-reference>
sender
string or null <iri-reference>
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "number": "string",
  • "message": "string",
  • "useGateway": true,
  • "use2way": true,
  • "voipNumber": "/entity/1",
  • "sender": "/entity/1",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "number": "string",
  • "message": "string",
  • "useGateway": true,
  • "use2way": true,
  • "voipNumber": "/entity/1",
  • "sender": {
    },
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR send SMS action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSetStatus

Creates an IVR set status action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSetStatus resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": "/entity/1",
  • "condition": "string",
  • "conditionLessThanTimeLimit": 0,
  • "conditionMoreThanTimeLimit": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR set status action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSetStatus resource

status
string or null <iri-reference>
condition
string
conditionLessThanTimeLimit
integer
conditionMoreThanTimeLimit
integer
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "status": "/entity/1",
  • "condition": "string",
  • "conditionLessThanTimeLimit": 0,
  • "conditionMoreThanTimeLimit": 0,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": "/entity/1",
  • "condition": "string",
  • "conditionLessThanTimeLimit": 0,
  • "conditionMoreThanTimeLimit": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR set status action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSignalError

Creates an IVR signal error action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSignalError resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR signal error action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSignalError resource

enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR signal error action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSignalFax

Creates an IVR signal fax action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSignalFax resource

fax
string or null <iri-reference>
scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "fax": "/entity/1",
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fax": {
    },
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR signal fax action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSignalFax resource

fax
string or null <iri-reference>
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "fax": "/entity/1",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "fax": {
    },
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR signal fax action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionSignalOk

Creates an IVR signal ok action

Authorizations:
apiKey
Request Body schema:

The new IvrActionSignalOk resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR signal ok action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionSignalOk resource

enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR signal ok action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionVoicemail

Creates an IVR voicemail actions

Authorizations:
apiKey
Request Body schema:

The new IvrActionVoicemail resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "useSystemMessage": true,
  • "useDefaultEmail": true,
  • "ivrMedia": "/entity/1",
  • "emails": [
    ],
  • "enabled": true,
  • "final": true,
  • "defaultEmail": "string",
  • "media": {
    },
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR voicemail action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionVoicemail resource

useSystemMessage
boolean
useDefaultEmail
boolean
ivrMedia
string or null <iri-reference>
emails
Array of strings
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "useSystemMessage": true,
  • "useDefaultEmail": true,
  • "ivrMedia": "/entity/1",
  • "emails": [
    ],
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "useSystemMessage": true,
  • "useDefaultEmail": true,
  • "ivrMedia": "/entity/1",
  • "emails": [
    ],
  • "enabled": true,
  • "final": true,
  • "defaultEmail": "string",
  • "media": {
    },
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR voicemail action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrActionWelcomeMessage

Creates an IVR welcome message action

Authorizations:
apiKey
Request Body schema:

The new IvrActionWelcomeMessage resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "voice": "/entity/1",
  • "startingMessage": "string",
  • "endingMessage": "string",
  • "enabled": true,
  • "final": true,
  • "language": "string",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR welcome message action

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrActionWelcomeMessage resource

voice
string or null <iri-reference>
startingMessage
string
endingMessage
string
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "voice": "/entity/1",
  • "startingMessage": "string",
  • "endingMessage": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "voice": "/entity/1",
  • "startingMessage": "string",
  • "endingMessage": "string",
  • "enabled": true,
  • "final": true,
  • "language": "string",
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR welcome message action

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionAuth

Creates an IVR authentication condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionAuth resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "authMode": "pin",
  • "pin": "string",
  • "authLanguage": "pl",
  • "authMessage": "/entity/1",
  • "authFailureMessage": "/entity/1",
  • "systemAuthMessage": true,
  • "systemAuthFailureMessage": true,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR authentication condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionAuth resource

authMode
string
Enum: "pin" "pinList" "phoneList"
pin
string or null
authLanguage
string
Enum: "pl" "en"
authMessage
string or null <iri-reference>
authFailureMessage
string or null <iri-reference>
systemAuthMessage
boolean
systemAuthFailureMessage
boolean
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "authMode": "pin",
  • "pin": "string",
  • "authLanguage": "pl",
  • "authMessage": "/entity/1",
  • "authFailureMessage": "/entity/1",
  • "systemAuthMessage": true,
  • "systemAuthFailureMessage": true,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "authMode": "pin",
  • "pin": "string",
  • "authLanguage": "pl",
  • "authMessage": "/entity/1",
  • "authFailureMessage": "/entity/1",
  • "systemAuthMessage": true,
  • "systemAuthFailureMessage": true,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR authentication condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionCheckIncomingNumber

Creates an IVR check incoming number condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionCheckIncomingNumber resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": "string",
  • "conditionType": "string",
  • "condition": "string",
  • "conditionVariable": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR check incoming number condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionCheckIncomingNumber resource

type
string
conditionType
string
condition
string or null
conditionVariable
string
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "type": "string",
  • "conditionType": "string",
  • "condition": "string",
  • "conditionVariable": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": "string",
  • "conditionType": "string",
  • "condition": "string",
  • "conditionVariable": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR check incoming number condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionCheckTable

Creates an IVR check table condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionCheckTable resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "table": "/entity/1",
  • "searchFor": "string",
  • "variableColumn2": 0,
  • "variableColumn3": 0,
  • "variableColumn4": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR check table condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionCheckTable resource

table
string or null <iri-reference>
searchFor
string
variableColumn2
integer or null
variableColumn3
integer or null
variableColumn4
integer or null
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "table": "/entity/1",
  • "searchFor": "string",
  • "variableColumn2": 0,
  • "variableColumn3": 0,
  • "variableColumn4": 0,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "table": "/entity/1",
  • "searchFor": "string",
  • "variableColumn2": 0,
  • "variableColumn3": 0,
  • "variableColumn4": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR check table condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionCheckVariable

Creates an IVR check variables condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionCheckVariable resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "variable": 0,
  • "condition": "string",
  • "conditionValue": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR check variables condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionCheckVariable resource

variable
integer
condition
string
conditionValue
string
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "variable": 0,
  • "condition": "string",
  • "conditionValue": "string",
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "variable": 0,
  • "condition": "string",
  • "conditionValue": "string",
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR check variables condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionStatus

Creates an IVR status condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionStatus resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "conditions": [
    ],
  • "enabled": true,
  • "final": true,
  • "availableConditions": [
    ],
  • "isAfterQueue": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR status condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionStatus resource

conditions
Array of strings
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "conditions": [
    ],
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "conditions": [
    ],
  • "enabled": true,
  • "final": true,
  • "availableConditions": [
    ],
  • "isAfterQueue": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR status condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrConditionTime

Creates an IVR time condition

Authorizations:
apiKey
Request Body schema:

The new IvrConditionTime resource

scenario
string or null <iri-reference>
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "scenario": "/entity/1",
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "usePolishHolidays": true,
  • "useCustomHolidays": true,
  • "dayFrom": 0,
  • "dayTo": 0,
  • "hourFrom": 0,
  • "minuteFrom": 0,
  • "hourTo": 0,
  • "minuteTo": 0,
  • "type": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Modifies an IVR time condition

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrConditionTime resource

usePolishHolidays
boolean
useCustomHolidays
boolean
dayFrom
integer
dayTo
integer
hourFrom
integer
minuteFrom
integer
hourTo
integer
minuteTo
integer
type
string
Enum: 0 1
enabled
boolean
parentTrue
string or null <iri-reference>
parentFalse
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "usePolishHolidays": true,
  • "useCustomHolidays": true,
  • "dayFrom": 0,
  • "dayTo": 0,
  • "hourFrom": 0,
  • "minuteFrom": 0,
  • "hourTo": 0,
  • "minuteTo": 0,
  • "type": 0,
  • "enabled": true,
  • "parentTrue": "/entity/1",
  • "parentFalse": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "usePolishHolidays": true,
  • "useCustomHolidays": true,
  • "dayFrom": 0,
  • "dayTo": 0,
  • "hourFrom": 0,
  • "minuteFrom": 0,
  • "hourTo": 0,
  • "minuteTo": 0,
  • "type": 0,
  • "enabled": true,
  • "final": true,
  • "position": 0,
  • "editable": true,
  • "nextFalse": {
    },
  • "nextTrue": {
    },
  • "price": 0,
  • "starting": true,
  • "isEnding": true,
  • "alwaysTrue": true,
  • "allowedNext": [
    ]
}

Removes an IVR time condition

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrMedia

IVR media

Authorizations:
apiKey

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

A single IVR medium

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "mediaObject": {
    }
}

Removes an IVR medium

Authorizations:
apiKey
path Parameters
id
required
string

Responses

IvrQueue

Creates a IvrQueue resource.

Authorizations:
apiKey
Request Body schema:

The new IvrQueue resource

name
required
string
customer
string <iri-reference>

Responses

Request samples

Content type
{
  • "name": "string",
  • "customer": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "agents": [
    ],
  • "name": "string",
  • "pickUpMessage": "/entity/1",
  • "useKeypadActions": true,
  • "announceToFirstUser": true,
  • "announceToFirstUserSystemMessage": 0,
  • "announceToFirstUserDefaultMessage": true,
  • "announceToFirstUserMessage": "/entity/1",
  • "positionInQueueMessage": "/entity/1",
  • "positionInQueueDefaultMessage": true,
  • "thankYouSystemMessage": 0,
  • "thankYouDefaultMessage": true,
  • "thankYouMessage": "/entity/1",
  • "notificationEmail": "string",
  • "messageInterval": 0,
  • "announceWaitingTime": true,
  • "breakBetweenCalls": 0,
  • "callsLimit": 0,
  • "strategy": "ringall",
  • "reportWaitingTime": true,
  • "weight": 0,
  • "periodicMessage": "/entity/1",
  • "periodicMessageInterval": 0,
  • "announcePosition": "yes",
  • "announcePositionLimit": 0,
  • "autofill": true,
  • "abandonNoSipAgents": true,
  • "abandonNoActiveAgents": true,
  • "deactivateNotAnsweringAgents": true,
  • "connected": 0,
  • "queued": 0,
  • "dialer": true,
  • "availableSIPs": [
    ],
  • "ivrActionQueueScenarios": {
    }
}

IVR queues

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

A single IVR queue

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "agents": [
    ],
  • "name": "string",
  • "pickUpMessage": "/entity/1",
  • "useKeypadActions": true,
  • "announceToFirstUser": true,
  • "announceToFirstUserSystemMessage": 0,
  • "announceToFirstUserDefaultMessage": true,
  • "announceToFirstUserMessage": "/entity/1",
  • "positionInQueueMessage": "/entity/1",
  • "positionInQueueDefaultMessage": true,
  • "thankYouSystemMessage": 0,
  • "thankYouDefaultMessage": true,
  • "thankYouMessage": "/entity/1",
  • "notificationEmail": "string",
  • "messageInterval": 0,
  • "announceWaitingTime": true,
  • "breakBetweenCalls": 0,
  • "callsLimit": 0,
  • "strategy": "ringall",
  • "reportWaitingTime": true,
  • "weight": 0,
  • "periodicMessage": "/entity/1",
  • "periodicMessageInterval": 0,
  • "announcePosition": "yes",
  • "announcePositionLimit": 0,
  • "autofill": true,
  • "abandonNoSipAgents": true,
  • "abandonNoActiveAgents": true,
  • "deactivateNotAnsweringAgents": true,
  • "connected": 0,
  • "queued": 0,
  • "dialer": true,
  • "availableSIPs": [
    ],
  • "ivrActionQueueScenarios": {
    }
}

IvrQueueAgent

Creates a IvrQueueAgent resource.

Authorizations:
apiKey
Request Body schema:

The new IvrQueueAgent resource

sip
string or null <iri-reference>
phoneNumber
string or null
queue
string <iri-reference>
sipInterface
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "sip": "/entity/1",
  • "phoneNumber": "string",
  • "queue": "/entity/1",
  • "sipInterface": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "phoneNumber": "string",
  • "priority": 0,
  • "autoEnable": true,
  • "dialTime": 0,
  • "disableOnInactivity": true,
  • "enabled": true,
  • "sipInterface": {
    },
  • "name": "string"
}

Retrieves the collection of IvrQueueAgent resources.

Authorizations:
apiKey
query Parameters
unique
boolean
queue
string
queue[]
Array of strings
order[priority]
string
Enum: "asc" "desc"
order[enabled]
string
Enum: "asc" "desc"
order[autoEnable]
string
Enum: "asc" "desc"
order[dialTime]
string
Enum: "asc" "desc"
order[disableOnInactivity]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[sip]
string
Enum: "asc" "desc"
pagination
boolean

Enable or disable pagination

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a IvrQueueAgent resource.

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "phoneNumber": "string",
  • "priority": 0,
  • "autoEnable": true,
  • "dialTime": 0,
  • "disableOnInactivity": true,
  • "enabled": true,
  • "sipInterface": {
    },
  • "name": "string"
}

Replaces the IvrQueueAgent resource.

Authorizations:
apiKey
path Parameters
id
required
string
Request Body schema:

The updated IvrQueueAgent resource

priority
integer
autoEnable
boolean
dialTime
integer
disableOnInactivity
boolean
enabled
boolean
sipInterface
string or null <iri-reference>

Responses

Request samples

Content type
{
  • "priority": 0,
  • "autoEnable": true,
  • "dialTime": 0,
  • "disableOnInactivity": true,
  • "enabled": true,
  • "sipInterface": "/entity/1"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "sip": {
    },
  • "phoneNumber": "string",
  • "priority": 0,
  • "autoEnable": true,
  • "dialTime": 0,
  • "disableOnInactivity": true,
  • "enabled": true,
  • "sipInterface": {
    },
  • "name": "string"
}

Removes the IvrQueueAgent resource.

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Number

A list of all PSTN numbers.

PSTN numbers

Authorizations:
apiKey
query Parameters
number
string
region
string
region[]
Array of strings
country
string
country[]
Array of strings
sms
string
Enum: "NONE" "INCOMING" "ALL"
sms[]
Array of strings
Items Enum: "NONE" "INCOMING" "ALL"
inUse
boolean

Must be set to false to return only available numbers

onlySms
boolean
type
string
Enum: "normal" "silver" "golden"
mobile
boolean
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

A single PSTN number

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "number": "string",
  • "inUse": true,
  • "operator": "string",
  • "mobile": true,
  • "sms": "NONE",
  • "price": "string",
  • "activationPrice": "string",
  • "golden": true,
  • "isRemoved": true,
  • "domestic": true,
  • "country": "/entity/1",
  • "servicePrice": {
    },
  • "silver": true,
  • "onlySms": true,
  • "inRange": true,
  • "mobileServicePrice": {
    }
}

LiveCallStats

Real-time calls data.

Returns data about ongoing calls

Authorizations:
apiKey

Responses

Response samples

Content type
[
  • {
    }
]

SmsMessage

Provides access to sending Sms messages.

Send SMS

Authorizations:
apiKey
Request Body schema:

Sends an SMS message

sender
required
string
Enum: "random" "BramkaSMS" "2Way" "voipNumber" "smsSender"

"voipNumber" requires a correct VoipNumber in voipNumber property; "smsSender" requires a correct SmsSender in smsSender property

recipients
required
Array of strings
voipNumber
string or null <iri-reference>

Accepts only mobile numbers (mobile: true in @type: VoipNumber)

smsSender
string or null <iri-reference>
text
required
string
sendTime
string or null <date-time>
country
required
string <iri-reference>

Responses

Request samples

Content type
{
  • "sender": "random",
  • "recipients": [
    ],
  • "voipNumber": "/api/voip_numbers/50",
  • "smsSender": "/api/sms_senders/1",
  • "text": "string",
  • "sendTime": "2019-08-24T14:15:22Z",
  • "country": "/api/countries/96"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "queuedMessages": [
    ],
  • "status": "string"
}

SmsPrice

Retrieves the collection of SmsPrice resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

SmsSender

Retrieves the collection of SmsSender resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}