logo
API docs by Redocly

SuperVoIP (1.0.0)

Download OpenAPI specification:Download

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

Duration in minutes

callId
string
waitingTime
integer

Waiting time in seconds

Responses

Request samples

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

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
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
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": {
    }
}

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