{"basePath":"/v2","definitions":{"AccountPhonelineResponse":{"properties":{"alias":{"example":"Alan Turing","type":"string"},"id":{"example":"p0","type":"string"},"userId":{"example":"w0","type":"string"}},"type":"object"},"AccountPhonelinesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/AccountPhonelineResponse"},"type":"array"}},"type":"object"},"AccountResponse":{"properties":{"company":{"example":"Love sipgate","type":"string"},"email":{"example":"test@sipgate.de","type":"string"},"firstName":{"example":"Ada","type":"string"},"historyLifeTime":{"enum":["NONE","THIRTY_DAYS","UNLIMITED"],"type":"string"},"lastName":{"example":"Lovelace","type":"string"},"logoUrl":{"type":"string"},"mainProductType":{"enum":["AFFILIATE","BASIC","CLINQ","SATELLITE","SIMQUADRAT","TEAM","TRUNKING","FORMER_AFFILIATE","FORMER_BASIC","FORMER_SATELLITE","FORMER_SIMQUADRAT","FORMER_TEAM","FORMER_TRUNKING","FRONTDESK","UNKNOWN"],"type":"string"},"verified":{"default":false,"type":"boolean"}},"type":"object"},"AccountVerificationRequest":{"properties":{"verificationCode":{"example":"ABC123","readOnly":true,"type":"string"}},"required":["verificationCode"],"type":"object"},"ActivateSimRequest":{"properties":{"simId":{"example":"1234567","type":"string"}},"type":"object"},"ActiveRouting":{"properties":{"alias":{"example":"Alan Turing","type":"string"},"id":{"type":"string"}},"type":"object"},"AddCallEmailNotificationRequest":{"properties":{"cause":{"example":"MISSED","type":"string"},"direction":{"example":"INCOMING","type":"string"},"email":{"example":"grace.hopper@example.com","type":"string"},"endpointId":{"example":"e0/p0","type":"string"}},"required":["cause","direction","email","endpointId"],"type":"object"},"AddCallSmsNotificationRequest":{"properties":{"cause":{"example":"MISSED","type":"string"},"direction":{"example":"INCOMING","type":"string"},"endpointId":{"example":"e0/p0","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"required":["cause","direction","endpointId","number"],"type":"object"},"AddDirectDialRequest":{"properties":{"number":{"type":"string"},"userId":{"example":"w0","type":"string"}},"required":["userId"],"type":"object"},"AddFaxEmailNotificationRequest":{"properties":{"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"email":{"example":"grace.hopper@example.com","type":"string"},"faxlineId":{"example":"f0","type":"string"}},"required":["direction","email","faxlineId"],"type":"object"},"AddFaxReportEmailNotificationRequest":{"properties":{"email":{"example":"grace.hopper@example.com","type":"string"},"faxlineId":{"example":"f0","type":"string"}},"required":["email","faxlineId"],"type":"object"},"AddFaxSmsNotificationRequest":{"properties":{"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"faxlineId":{"example":"f0","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"required":["direction","faxlineId","number"],"type":"object"},"AddGreetingRequest":{"properties":{"base64Content":{"example":"RG8uIE9yIGRvIG5vdC4gVGhlcmUgaXMgbm8gdHJ5LiAtLVlvZGEK","maxLength":15000000,"minLength":0,"type":"string"},"filename":{"example":"greeting.mp3","type":"string"}},"type":"object"},"AddSmsEmailNotificationRequest":{"properties":{"email":{"example":"grace.hopper@example.com","type":"string"},"endpointId":{"example":"y0","type":"string"}},"required":["email","endpointId"],"type":"object"},"AddVoicemailEmailVoicemailNotificationRequest":{"properties":{"email":{"example":"grace.hopper@example.com","type":"string"},"voicemailId":{"example":"v0","type":"string"}},"required":["email","voicemailId"],"type":"object"},"AddVoicemailSmslVoicemailNotificationRequest":{"properties":{"number":{"example":"+4915799912345","type":"string"},"voicemailId":{"example":"v0","type":"string"}},"required":["number","voicemailId"],"type":"object"},"AddressRequest":{"properties":{"country":{"type":"string"},"extendedAddress":{"type":"string"},"locality":{"type":"string"},"poBox":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"items":{"type":"string"},"type":"array"}},"type":"object"},"AddressResponse":{"properties":{"address1":{"example":"1-3 Spring Gardens","type":"string"},"address2":{"example":"Flat A","type":"string"},"addressId":{"example":"123456","type":"string"},"city":{"example":"Düsseldorf","type":"string"},"countrycode":{"example":"DE","type":"string"},"emergencyState":{"enum":["NONE","FAILED","PENDING","ACTIVATED","SUBMIT","SUBMIT_DELETE","PENDING_DELETE","SUBMITNOVALIDATE"],"type":"string"},"number":{"example":"74","type":"string"},"numbersUrl":{"example":"/addresses/12345/numbers","type":"string"},"postcode":{"example":"40219","type":"string"},"state":{"example":"NRW","type":"string"},"street":{"example":"Gladbacher Str.","type":"string"},"type":{"enum":["VERIFIED","PENDING","FAILED","BLOCKED","NONE"],"type":"string"}},"type":"object"},"AddressesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/AddressResponse"},"type":"array"}},"type":"object"},"AnnouncementRequest":{"properties":{"url":{"description":"The URL pointing to the announcement WAV file.","example":"https://static.sipgate.com/examples/wav/example.wav","type":"string"}},"required":["url"],"type":"object"},"ApiUrlsResponse":{"properties":{"accountUrl":{"type":"string"},"accountVerifiedUrl":{"type":"string"},"addDirectDialUrl":{"type":"string"},"addressNumbersUrl":{"type":"string"},"addressUrl":{"type":"string"},"addressesUrl":{"type":"string"},"authorizationOauthClientUrl":{"type":"string"},"authorizationOauthClientsUrl":{"type":"string"},"authorizationTokenUrl":{"type":"string"},"balanceUrl":{"type":"string"},"callRestrictionsUrl":{"type":"string"},"changeDirectDialUrl":{"type":"string"},"contactsUrl":{"type":"string"},"crmBridgeUrl":{"type":"string"},"deleteDirectDialUrl":{"type":"string"},"deviceCallerIdUrl":{"type":"string"},"deviceSimOrdersUrl":{"type":"string"},"deviceUrl":{"type":"string"},"devicesSingleRowDisplayUrl":{"type":"string"},"devicesTariffAnnouncementUrl":{"type":"string"},"faxlineNumbersUrl":{"type":"string"},"faxlineUrl":{"type":"string"},"faxlinesUrl":{"type":"string"},"getCallRestrictionsUrl":{"type":"string"},"groupDetailUrl":{"type":"string"},"groupDevicesUrl":{"type":"string"},"groupNumbersUrl":{"type":"string"},"groupUserUrl":{"type":"string"},"groupsUrl":{"type":"string"},"historyEntryUrl":{"type":"string"},"historyUrl":{"type":"string"},"internalContactsUrl":{"type":"string"},"notificationsUrl":{"type":"string"},"numberUrl":{"type":"string"},"numbersUrl":{"type":"string"},"phonelineBlockAnonymousUrl":{"type":"string"},"phonelineDetailUrl":{"type":"string"},"phonelineDevicesUrl":{"type":"string"},"phonelineForwardingsUrl":{"type":"string"},"phonelineNumbersUrl":{"type":"string"},"phonelineSipgateIoLogUrl":{"type":"string"},"phonelineSipgateIoUrl":{"type":"string"},"phonelineUrl":{"type":"string"},"phonelineVoicemailGreetingUrl":{"type":"string"},"phonelineVoicemailGreetingsUrl":{"type":"string"},"phonelineVoicemailUrl":{"type":"string"},"phonelineVoicemailsUrl":{"type":"string"},"phonelinesParallelForwardingUrl":{"type":"string"},"phonelinesParallelForwardingsUrl":{"type":"string"},"phonelinesUrl":{"type":"string"},"portingUrl":{"type":"string"},"portingsUrl":{"type":"string"},"restrictionsUrl":{"type":"string"},"sessionsCallUrl":{"type":"string"},"settingsSipgateioUrl":{"type":"string"},"smsCallerIdsUrl":{"type":"string"},"smsUrl":{"type":"string"},"translationsUrl":{"type":"string"},"userBusyOnBusyUrl":{"type":"string"},"userDefaultDeviceUrl":{"type":"string"},"userDeviceSimUrl":{"type":"string"},"userDevicesUrl":{"type":"string"},"userExternalDevicesUrl":{"type":"string"},"userInfoUrl":{"type":"string"},"userMobileDevicesUrl":{"type":"string"},"userRegisterDevicesUrl":{"type":"string"},"userRoleUrl":{"type":"string"},"userUrl":{"type":"string"},"usersUrl":{"type":"string"},"voicemailDetailUrl":{"type":"string"},"voicemailsUrl":{"type":"string"},"webuserNumbersUrl":{"type":"string"}},"type":"object"},"BalanceResponse":{"properties":{"amount":{"example":"35000 (Amount multiplied by 10000 (35000/10000=EUR 3.50))","format":"int32","type":"integer"},"currency":{"example":"EUR","type":"string"}},"type":"object"},"BooleanRequest":{"properties":{"value":{"description":"true or false","example":true,"type":"boolean"}},"required":["value"],"type":"object"},"Call":{"properties":{"callId":{"description":"The unique call identifier","example":"ABCDEF0123456789","type":"string"},"hold":{"description":"The call is on hold. Note: for Neo PBX accounts this value is always false.","example":false,"type":"boolean"},"muted":{"description":"The call is muted. Note: for Neo PBX accounts this value is always false.","example":false,"type":"boolean"},"participants":{"items":{"$ref":"#/definitions/Participant"},"type":"array"},"recording":{"description":"The call is being recorded","example":false,"type":"boolean"}},"required":["callId","hold","muted","participants","recording"],"type":"object"},"CallEmailTarget":{"properties":{"cause":{"enum":["MISSED","SUCCESSFUL"],"type":"string"},"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"email":{"example":"grace.hopper@example.com","type":"string"},"id":{"example":"42","type":"string"}},"type":"object"},"CallNotificationResponse":{"properties":{"emails":{"items":{"$ref":"#/definitions/CallEmailTarget"},"type":"array"},"endpointAlias":{"example":"Fax/Voicemail of Grace Hopper","type":"string"},"endpointId":{"example":"f0/v0/p0","type":"string"},"sms":{"items":{"$ref":"#/definitions/CallSmsTarget"},"type":"array"}},"type":"object"},"CallRestrictionResponse":{"properties":{"charged":{"default":false,"example":false,"type":"boolean"},"foreignSpecial":{"default":false,"example":false,"type":"boolean"},"highCostForeignNumbers":{"default":false,"example":false,"type":"boolean"},"roaming":{"default":false,"example":false,"type":"boolean"},"userId":{"example":"w0","type":"string"}},"type":"object"},"CallSmsTarget":{"properties":{"cause":{"enum":["MISSED","SUCCESSFUL"],"type":"string"},"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"id":{"example":"1337","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"CallerIdRequest":{"properties":{"value":{"example":"+4915799912345","type":"string"}},"type":"object"},"CallerIdResponse":{"properties":{"value":{"example":"+4915799912345","type":"string"}},"type":"object"},"Calls":{"properties":{"data":{"items":{"$ref":"#/definitions/Call"},"type":"array"}},"type":"object"},"ChangeDeviceRequest":{"properties":{"dnd":{"default":false,"type":"boolean"},"emergencyAddressId":{"format":"int32","type":"integer"}},"type":"object"},"ChangeDirectDialRequest":{"properties":{"number":{"type":"string"},"userId":{"example":"w0","type":"string"}},"required":["userId"],"type":"object"},"ChangeExternalDeviceIncomingCallDisplayRequest":{"properties":{"incomingCallDisplay":{"enum":["CALLED_NUMBER","CALLER_NUMBER"],"type":"string"}},"required":["incomingCallDisplay"],"type":"object"},"ChangeExternalDeviceTargetNumberRequest":{"properties":{"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"ChangeNumberSettingsRequest":{"properties":{"endpointId":{"example":"p0","type":"string"},"quickDial":{"default":false,"example":false,"type":"boolean"},"releaseForMnp":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"ChangeVoicemailGreetingRequest":{"properties":{"active":{"default":false,"type":"boolean"}},"type":"object"},"ChangeVoicemailRequest":{"properties":{"active":{"default":false,"type":"boolean"},"timeout":{"example":42,"format":"int32","minimum":0.0,"type":"integer"},"transcription":{"default":false,"type":"boolean"}},"required":["active","transcription"],"type":"object"},"ChangeVoicemailTranscriptionRequest":{"properties":{"active":{"default":false,"type":"boolean"}},"type":"object"},"ChannelCall":{"properties":{"callSid":{"type":"string"},"channelId":{"type":"string"},"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"establishedAt":{"example":"2025-10-23T14:30:45Z","type":"string"},"forwarding":{"$ref":"#/definitions/Forwarding"},"from":{"description":"Phone number of the calling party. For outgoing calls this is the channel's own number, for incoming calls the remote party's number.","type":"string"},"owner":{"description":"User who conducted the call. For outgoing calls the initiating user, for incoming calls the user that accepted the call. Null for missed calls.","example":"w0","type":"string","x-nullable":true},"startedAt":{"example":"2025-10-23T14:30:45Z","type":"string"},"state":{"enum":["RINGING","ESTABLISHED","FINISHED","MISSED","REJECTED","TRANSFERRING","TRANSFERRED","TRANSFER_FAILED","BUSY","CLIENT_ERROR","UNKNOWN"],"type":"string"},"terminatedAt":{"example":"2025-10-23T14:30:45Z","type":"string"},"terminatedReason":{"enum":["CANCELLED","TERMINATED","UNKNOWN"],"type":"string"},"to":{"description":"Phone number of the called party. For outgoing calls this is the remote party's number, for incoming calls the channel's own number.","type":"string"}},"type":"object"},"ChannelEvent":{"properties":{"call":{"$ref":"#/definitions/ChannelCall"},"createdAt":{"example":"2025-10-23T14:30:45Z","type":"string"},"eventId":{"type":"string"},"recordings":{"items":{"$ref":"#/definitions/Recording"},"type":"array"},"type":{"enum":["CALL"],"type":"string"}},"type":"object"},"ChannelInbox":{"properties":{"events":{"items":{"$ref":"#/definitions/ChannelEvent"},"type":"array"},"limit":{"format":"int32","type":"integer"},"position":{"type":"string"}},"type":"object"},"ChannelListResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/ChannelResponse"},"type":"array","uniqueItems":true}},"type":"object"},"ChannelQueueSettingsResponse":{"properties":{"respectWaitingTime":{"type":"boolean"},"waitingAudioFileId":{"type":"string"}},"type":"object"},"ChannelResponse":{"properties":{"createdAt":{"type":"string"},"id":{"type":"string"},"locale":{"example":"en-US","type":"string"},"name":{"type":"string"},"owner":{"type":"string"},"settings":{"$ref":"#/definitions/ChannelSettingsResponse"},"users":{"items":{"$ref":"#/definitions/ChannelUserResponse"},"type":"array","uniqueItems":true}},"type":"object"},"ChannelRingingOrderResponse":{"discriminator":"type","properties":{"type":{"type":"string"},"users":{"items":{"type":"string"},"type":"array"}},"required":["type"],"type":"object"},"ChannelSettingsResponse":{"properties":{"greetingAudioFileId":{"type":"string"},"queue":{"$ref":"#/definitions/ChannelQueueSettingsResponse"},"ringingOrder":{"$ref":"#/definitions/ChannelRingingOrderResponse"},"smsSim":{"type":"string"},"users":{"$ref":"#/definitions/ChannelUserSettingsResponse"},"voiceboxAccessNumber":{"format":"int32","type":"integer"}},"type":"object"},"ChannelUserResponse":{"properties":{"deviceIds":{"items":{"type":"string"},"type":"array","uniqueItems":true},"id":{"type":"string"}},"type":"object"},"ChannelUserSettingsResponse":{"properties":{"followUpTime":{"format":"int32","type":"integer"},"ringTime":{"format":"int32","type":"integer"}},"type":"object"},"ChannelUsersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/ChannelUserResponse"},"type":"array","uniqueItems":true}},"type":"object"},"ContactResponse":{"properties":{"addresses":{"items":{"$ref":"#/definitions/AddressResponse"},"type":"array"},"emails":{"items":{"$ref":"#/definitions/EMailResponse"},"type":"array"},"familyname":{"example":"Lovelace","type":"string"},"givenname":{"example":"Ada","type":"string"},"id":{"example":"b3d9af4a-78f9-11e6-8b77-86f30ca893d3","type":"string"},"name":{"example":"Ada Lovelace","type":"string"},"note":{"type":"string"},"numbers":{"items":{"$ref":"#/definitions/NumberResponse"},"type":"array"},"organization":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"picture":{"description":"base64 encoded file content","example":"4AAQSkZJRgABAQAAAQABAAD...","type":"string"},"scope":{"enum":["PRIVATE","SHARED","INTERNAL"],"type":"string"},"websites":{"items":{"$ref":"#/definitions/WebsiteResponse"},"type":"array"}},"type":"object"},"ContactsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/ContactResponse"},"type":"array"},"totalCount":{"format":"int32","type":"integer"}},"type":"object"},"ContactsSetResult":{"properties":{"contactId":{"type":"string"},"valid_from":{"type":"string"}},"type":"object"},"ContingentResponse":{"properties":{"amount":{"example":2500,"format":"int32","type":"integer"},"expires":{"example":"2016-02-10T14:19:39Z","type":"string"},"left":{"example":1500,"format":"int32","type":"integer"},"type":{"example":"DATA_FAST","type":"string"},"unit":{"example":"KILOBYTE","type":"string"},"used":{"example":1000,"format":"int32","type":"integer"}},"type":"object"},"CreateCallResponse":{"properties":{"callSid":{"description":"The unique call session ID","example":"pbx-c-ffffffff-abba-acdc-aabb-ffffffffffff","type":"string"}},"type":"object"},"CreateContactRequest":{"properties":{"addresses":{"items":{"$ref":"#/definitions/AddressRequest"},"type":"array"},"emails":{"items":{"$ref":"#/definitions/EmailRequest"},"type":"array"},"family":{"example":"Lovelace","type":"string"},"given":{"example":"Ada","type":"string"},"name":{"example":"Ada Lovelace","type":"string"},"note":{"type":"string"},"numbers":{"items":{"$ref":"#/definitions/NumberRequest"},"type":"array"},"organization":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"picture":{"example":"NEFBUVNrWkpSZ0FCQVFBQUFRQUJBQUQuLi4=","format":"byte","type":"string"},"scope":{"enum":["PRIVATE","SHARED","INTERNAL","PRIVATE,SHARED"],"example":"PRIVATE","type":"string"},"websites":{"items":{"$ref":"#/definitions/WebsiteRequest"},"type":"array"}},"type":"object"},"CreateDeviceRequest":{"properties":{"alias":{"example":"VoIP phone of Grace Hopper","type":"string"},"type":{"enum":["REGISTER","MOBILE","EXTERNAL"],"type":"string"}},"required":["type"],"type":"object"},"CreateExternalDeviceRequest":{"properties":{"alias":{"example":"External phone of Grace Hopper","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"CreateMobileDeviceRequest":{"properties":{"alias":{"example":"Mobile phone phone of Grace Hopper","type":"string"}},"type":"object"},"CreateRegisterDeviceRequest":{"properties":{"alias":{"example":"VoIP phone of Grace Hopper","type":"string"}},"type":"object"},"CredentialsResponse":{"properties":{"outboundProxy":{"type":"string"},"password":{"type":"string"},"sipServer":{"type":"string"},"sipServerWebsocketUrl":{"type":"string"},"username":{"type":"string"}},"type":"object"},"DeleteContactResponse":{"properties":{"deleteCount":{"format":"int64","type":"integer"}},"type":"object"},"DeleteRequest":{"properties":{"contactIds":{"items":{"type":"string"},"type":"array"},"scope":{"default":"PRIVATE","enum":["PRIVATE,SHARED"],"example":"PRIVATE","items":{"default":"PRIVATE","enum":["PRIVATE","SHARED","INTERNAL","PRIVATE,SHARED"],"example":"PRIVATE","type":"string"},"type":"array"},"source":{"type":"string"}},"type":"object"},"DetailedError":{"properties":{"detail":{"description":"The detailed description of the error","example":"It appears that you are not authorized to pass","type":"string"},"source":{"$ref":"#/definitions/ErrorSource"},"status":{"description":"The status code","example":"401","format":"int32","type":"integer"},"title":{"description":"The title of the error","example":"You shall not pass","type":"string"}},"type":"object"},"DeviceContingentsResponse":{"properties":{"contingents":{"items":{"$ref":"#/definitions/ContingentResponse"},"type":"array"}},"type":"object"},"DeviceResponse":{"properties":{"activeGroups":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"activePhonelines":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"alias":{"example":"VoIP phone of Grace Hopper","type":"string"},"dnd":{"default":false,"type":"boolean"},"id":{"example":"e0","type":"string"},"online":{"default":false,"type":"boolean"},"type":{"enum":["REGISTER","MOBILE","EXTERNAL"],"type":"string"}},"type":"object"},"DevicesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/DeviceResponse"},"type":"array"}},"type":"object"},"DtmfRequest":{"properties":{"sequence":{"description":"DTMF sequence to send","example":"123456","type":"string"}},"required":["sequence"],"type":"object"},"EMailResponse":{"properties":{"email":{"example":"user@example.com","type":"string"},"type":{"items":{"type":"string"},"type":"array"}},"type":"object"},"EmailRequest":{"properties":{"email":{"example":"user@example.com","type":"string"},"type":{"items":{"type":"string"},"type":"array"}},"type":"object"},"EmailTarget":{"properties":{"email":{"example":"grace.hopper@example.com","type":"string"},"id":{"example":"42","type":"string"}},"type":"object"},"EndpointNumbersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/NumberResponse"},"type":"array"}},"type":"object"},"EndpointResponse":{"properties":{"extension":{"example":"e0","type":"string"},"type":{"enum":["SMS","REGISTER","EXTERNAL","FAX","MOBILE","GROUP","VOICEMAIL","PHONELINE","USER"],"type":"string"}},"type":"object"},"ErrorResponse":{"properties":{"errors":{"items":{"$ref":"#/definitions/DetailedError"},"type":"array"}},"type":"object"},"ErrorSource":{"description":"A more detailed info where the error occured","properties":{"pointer":{"description":"A pointer to indicate where the error occured","example":"You might be a Balrog","type":"string"}},"type":"object"},"EventResponse":{"properties":{"eventId":{"type":"string"},"eventName":{"type":"string"},"eventType":{"type":"string"},"payload":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"EventsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/EventResponse"},"type":"array"}},"type":"object"},"ExtensionSettingsResponse":{"properties":{"active":{"type":"boolean"}},"type":"object"},"ExternalDeviceResponse":{"properties":{"activeGroups":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"activePhonelines":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"alias":{"example":"VoIP phone of Grace Hopper","type":"string"},"dnd":{"default":false,"type":"boolean"},"id":{"example":"e0","type":"string"},"incomingCallDisplayState":{"enum":["CALLED_NUMBER","CALLER_NUMBER"],"type":"string"},"number":{"example":"+4915799912345","type":"string"},"online":{"default":false,"type":"boolean"},"type":{"enum":["REGISTER","MOBILE","EXTERNAL"],"type":"string"}},"type":"object"},"FaxEmailTarget":{"properties":{"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"email":{"example":"grace.hopper@example.com","type":"string"},"id":{"example":"42","type":"string"}},"type":"object"},"FaxNotificationResponse":{"properties":{"emails":{"items":{"$ref":"#/definitions/FaxEmailTarget"},"type":"array"},"endpointAlias":{"example":"Fax/Voicemail of Grace Hopper","type":"string"},"endpointId":{"example":"f0/v0/p0","type":"string"},"reports":{"items":{"$ref":"#/definitions/ReportTarget"},"type":"array"},"sms":{"items":{"$ref":"#/definitions/FaxSmsTarget"},"type":"array"}},"type":"object"},"FaxSmsTarget":{"properties":{"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"id":{"example":"1337","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"FaxlineCallerIdRequest":{"properties":{"value":{"example":"+4921112345678","type":"string"}},"type":"object"},"FaxlineCallerIdResponse":{"properties":{"value":{"example":"+4915799912345","type":"string"}},"type":"object"},"FaxlineResponse":{"properties":{"alias":{"example":"Alexander Bain's fax","type":"string"},"canReceive":{"default":false,"type":"boolean"},"canSend":{"default":false,"type":"boolean"},"id":{"example":"f0","type":"string"},"tagline":{"example":"Example Ltd.","type":"string"}},"type":"object"},"FaxlineTaglineRequest":{"properties":{"value":{"example":"Example Ltd.","type":"string"}},"type":"object"},"FaxlinesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/FaxlineResponse"},"type":"array"}},"type":"object"},"Forwarding":{"properties":{"target":{"type":"string"},"type":{"type":"string"}},"type":"object"},"GdprUrls":{"properties":{"privacyUrl":{"description":"The privacy policy URL","example":"https://www.example.com/privacy","type":"string"},"termsUrl":{"description":"The terms and conditions URL","example":"https://www.example.com/terms","type":"string"}},"title":"GdprUrls","type":"object"},"GetStructuredVCardsResponse":{"properties":{"contacts":{"items":{"$ref":"#/definitions/StructuredVCard"},"type":"array"},"overallMatches":{"format":"int32","type":"integer"}},"type":"object"},"GreetingResponse":{"properties":{"active":{"default":false,"type":"boolean"},"alias":{"example":"My Greeting","type":"string"},"greetingUrl":{"example":"https://www.example.com/greeting.mp3","type":"string"},"id":{"example":"42","type":"string"},"recordingEnabled":{"default":false,"type":"boolean"}},"type":"object"},"GreetingsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/GreetingResponse"},"type":"array"}},"type":"object"},"GroupFaxlineResponse":{"properties":{"alias":{"example":"Alexander Bain's fax","type":"string"},"canReceive":{"default":false,"type":"boolean"},"canSend":{"default":false,"type":"boolean"},"groupId":{"example":"f0","type":"string"},"id":{"example":"f0","type":"string"},"tagline":{"example":"Example Ltd.","type":"string"}},"type":"object"},"GroupFaxlinesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/GroupFaxlineResponse"},"type":"array"}},"type":"object"},"GroupNumbersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/NumberResponse"},"type":"array"}},"type":"object"},"GroupResponse":{"properties":{"alias":{"example":"Turings Group","type":"string"},"departmentId":{"format":"int64","type":"integer"},"id":{"example":"g0","type":"string"},"voicemails":{"items":{"$ref":"#/definitions/VoicemailSettingsResponse"},"type":"array"}},"type":"object"},"GroupUserResponse":{"properties":{"firstname":{"example":"Ada","type":"string"},"id":{"example":"w0","type":"string"},"lastname":{"example":"Lovelace","type":"string"},"userUrl":{"type":"string"}},"type":"object"},"GroupUsersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/GroupUserResponse"},"type":"array"}},"type":"object"},"HistoryEntryResponse":{"properties":{"archived":{"default":false,"type":"boolean"},"connectionIds":{"items":{"type":"string"},"type":"array"},"created":{"example":"2016-02-10T14:19:39Z","type":"string"},"direction":{"enum":["INCOMING","OUTGOING","MISSED_INCOMING","MISSED_OUTGOING"],"type":"string"},"endpoints":{"description":"An ordered list of endpoints the event moved through","items":{"$ref":"#/definitions/RoutedEndpointResponse"},"type":"array"},"id":{"example":"100001234","type":"string"},"incoming":{"default":false,"type":"boolean"},"labels":{"items":{"type":"string"},"type":"array","uniqueItems":true},"lastModified":{"example":"2016-02-10T14:19:39Z","type":"string"},"note":{"type":"string"},"read":{"default":false,"example":true,"type":"boolean"},"source":{"example":"anonymous","type":"string"},"sourceAlias":{"example":"Dennis Ritchie","type":"string"},"starred":{"default":false,"type":"boolean"},"status":{"enum":["NOPICKUP","BUSY","PICKUP","FORWARD"],"type":"string"},"target":{"example":"01579-9912345","type":"string"},"targetAlias":{"example":"Ken Thompson","type":"string"},"type":{"enum":["CALL","VOICEMAIL","SMS","FAX"],"type":"string"}},"type":"object"},"HistoryResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/HistoryEntryResponse"},"type":"array"},"totalCount":{"format":"int32","type":"integer"}},"type":"object"},"ImportCSVRequest":{"properties":{"base64Content":{"example":"Zmlyc3RuYW1lLGxhc3RuYW1lLG51bWJlcgpBZGEsTG92ZWxhY2UsKzQ5MTU3OTk5MTIzNDUKQWxhbixUdXJpbmcsKzQ5MTU3OTk5MTIzNDUK","minLength":1,"type":"string"}},"required":["base64Content"],"type":"object"},"ImportGoogleRequest":{"properties":{"scope":{"default":"PRIVATE","enum":["PRIVATE","SHARED","INTERNAL","PRIVATE,SHARED"],"example":"PRIVATE","type":"string"},"token":{"type":"string"}},"type":"object"},"ImportGoogleResponse":{"properties":{"totalCount":{"format":"int32","type":"integer"}},"type":"object"},"IncomingEntries":{"properties":{"items":{"items":{"$ref":"#/definitions/IncomingEntry"},"type":"array"}},"type":"object"},"IncomingEntry":{"properties":{"isBlock":{"default":false,"description":"Should phone numbers be blocked beginning with given number","example":"true","type":"boolean"},"phoneNumber":{"description":"Recommended request format: phone number in E.164 format without leading +, e.g. 492117654321. Entries are stored with a leading + and returned that way. Do not use national numbers with leading 0, e.g. use 49151... instead of 0151....","example":"492117654321","pattern":"^\\+?[1-9]\\d{1,14}$","type":"string"}},"required":["phoneNumber"],"type":"object"},"InitiateNewCallSessionResponse":{"properties":{"sessionId":{"type":"string"}},"type":"object"},"InternalContactResponse":{"properties":{"contactId":{"example":"e6bdd18a-74c2-4d3c-9d95-5e91f6f335dc","type":"string"},"directdial":{"items":{"type":"string"},"type":"array"},"emails":{"items":{"type":"string"},"type":"array"},"fax":{"items":{"type":"string"},"type":"array"},"id":{"example":"0a50261ebd1a390fed2bf326f2673c145582a63","type":"string"},"landline":{"items":{"type":"string"},"type":"array"},"mobile":{"items":{"type":"string"},"type":"array"},"name":{"example":"Ada Lovelace","type":"string"}},"type":"object"},"InternalContactsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/InternalContactResponse"},"type":"array"}},"type":"object"},"ItemCountResponse":{"properties":{"itemCount":{"example":123456,"format":"int32","type":"integer"}},"type":"object"},"LegacyForwardingRequest":{"properties":{"forwardings":{"items":{"$ref":"#/definitions/LegacyForwardingSetRequest"},"type":"array"}},"type":"object"},"LegacyForwardingResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/LegacyForwardingSetResponse"},"type":"array"}},"type":"object"},"LegacyForwardingSetRequest":{"properties":{"active":{"example":"true","type":"boolean"},"destination":{"example":"+4915799912345","type":"string"},"timeout":{"example":100,"format":"int32","type":"integer"}},"type":"object"},"LegacyForwardingSetResponse":{"properties":{"active":{"type":"boolean"},"alias":{"type":"string"},"destination":{"type":"string"},"timeout":{"format":"int32","type":"integer"}},"type":"object"},"LinksResponse":{"properties":{"accountSettingsUrl":{"type":"string"},"accountTopUpUrl":{"type":"string"},"accountsUrl":{"type":"string"},"adminProductSettingsUrl":{"type":"string"},"affiliateUrl":{"type":"string"},"aiAgentsHelpdeskUrl":{"type":"string"},"appleSignInUrl":{"type":"string"},"bookPhonenumberUrl":{"type":"string"},"brandUrl":{"type":"string"},"callPackageTacUrl":{"type":"string"},"callRecorderTacUrl":{"type":"string"},"crmIntegrationsUrl":{"type":"string"},"dataContingentTacUrl":{"type":"string"},"dataProcessingAgreementUrl":{"type":"string"},"devicePoolUrl":{"type":"string"},"generalTacUrl":{"type":"string"},"googleSignInUrl":{"type":"string"},"helpdeskPhoneConfigurationUrl":{"type":"string"},"helpdeskUrl":{"type":"string"},"legacyTokenAuthenticateUrl":{"type":"string"},"loginUrl":{"type":"string"},"logoTargetUrl":{"type":"string"},"logoutPageUrl":{"type":"string"},"logoutUrl":{"type":"string"},"microsoftPresenceRedirectUrl":{"type":"string"},"microsoftSignInUrl":{"type":"string"},"microsoftTeamsUrl":{"type":"string"},"mobileDataVisualizationUrl":{"type":"string"},"newStarterPriceList_121124":{"type":"string"},"nonEWRHelpcenterUrl":{"type":"string"},"notificationsUrl":{"type":"string"},"paymentSettingsUrl":{"type":"string"},"personalSettingsUrl":{"type":"string"},"presenceContainerUrl":{"type":"string"},"privacyPolicyUrl":{"type":"string"},"sendFaxUrl":{"type":"string"},"serviceDescriptionUrl":{"type":"string"},"simquadratUrl":{"type":"string"},"startUpPageUrl":{"type":"string"},"supportUrl":{"type":"string"},"testProgrammeUrl":{"type":"string"},"tokenAuthenticateUrl":{"type":"string"},"trunkContingentTacUrl":{"type":"string"},"trunkContractTacUrl":{"type":"string"},"trunkingContingentAdvertisementUrl":{"type":"string"},"userSettingsUrl":{"type":"string"},"wbciOptInUrl":{"type":"string"},"whatsNewUrl":{"type":"string"}},"type":"object"},"LocalprefixRequest":{"properties":{"active":{"default":false,"type":"boolean"},"value":{"example":"030","type":"string"}},"type":"object"},"LocalprefixResponse":{"properties":{"active":{"default":false,"type":"boolean"},"value":{"example":"0221","type":"string"}},"type":"object"},"MobileCredentialsResponse":{"properties":{"puk1":{"example":"12345","type":"string"},"puk2":{"example":"67890","type":"string"},"simId":{"example":"1234567","type":"string"}},"type":"object"},"MobileDeviceResponse":{"properties":{"activeGroups":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"activePhonelines":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"alias":{"example":"VoIP phone of Grace Hopper","type":"string"},"credentials":{"$ref":"#/definitions/MobileCredentialsResponse"},"dnd":{"default":false,"type":"boolean"},"esim":{"default":false,"type":"boolean"},"id":{"example":"e0","type":"string"},"online":{"default":false,"type":"boolean"},"simState":{"enum":["INACTIVE","PENDING","ACTIVE"],"type":"string"},"type":{"enum":["REGISTER","MOBILE","EXTERNAL"],"type":"string"}},"type":"object"},"ModifyAddressRequest":{"properties":{"address1":{"example":"1-3 Spring Gardens","type":"string"},"address2":{"example":"Flat A","type":"string"},"city":{"example":"Düsseldorf","type":"string"},"countrycode":{"example":"DE","type":"string"},"number":{"example":"74","type":"string"},"postcode":{"example":"40219","type":"string"},"state":{"example":"NRW","type":"string"},"street":{"example":"Gladbacher Str.","type":"string"}},"required":["city","countrycode","postcode"],"type":"object"},"NewCallRequest":{"properties":{"callee":{"example":"+4915799912345","type":"string"},"caller":{"example":"e0","type":"string"},"callerId":{"example":"+4915799912345","type":"string"},"deviceId":{"example":"e0","type":"string"}},"required":["callee","caller"],"type":"object"},"NewIvrRecordingRequest":{"properties":{"deviceId":{"example":"e0","type":"string"},"endpoint":{"example":"MAIN, a0,a1,a2","type":"string"},"targetId":{"example":"v0","type":"string"}},"type":"object"},"NewVoicemailRecordingRecordingRequest":{"properties":{"deviceId":{"example":"e0","type":"string"},"endpoint":{"example":"MAIN, a0,a1,a2","type":"string"},"targetId":{"example":"v0","type":"string"}},"type":"object"},"NotificationsResponse":{"properties":{"call":{"items":{"$ref":"#/definitions/CallNotificationResponse"},"type":"array"},"fax":{"items":{"$ref":"#/definitions/FaxNotificationResponse"},"type":"array"},"sms":{"items":{"$ref":"#/definitions/SmsNotificationResponse"},"type":"array"},"voicemail":{"items":{"$ref":"#/definitions/VoicemailNotificationResponse"},"type":"array"}},"type":"object"},"NumberRequest":{"properties":{"number":{"example":"+4915799912345","type":"string"},"type":{"items":{"type":"string"},"type":"array"}},"type":"object"},"NumberResponse":{"properties":{"id":{"type":"string"},"localized":{"example":"01579-9912345","type":"string"},"number":{"example":"+4915799912345","type":"string"},"type":{"enum":["MOBILE","LANDLINE","QUICKDIAL","INTERNATIONAL"],"type":"string"}},"type":"object"},"NumberResponseWithEndpoint":{"properties":{"addressId":{"format":"int32","type":"integer"},"blockId":{"format":"int32","type":"integer"},"endpointAlias":{"type":"string"},"endpointId":{"example":"p0","type":"string"},"endpointUrl":{"type":"string"},"id":{"type":"string"},"localized":{"example":"01579-9912345","type":"string"},"number":{"example":"+4915799912345","type":"string"},"prolongationId":{"format":"int64","type":"integer"},"type":{"enum":["MOBILE","LANDLINE","QUICKDIAL","INTERNATIONAL"],"type":"string"}},"type":"object"},"NumbersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/NumberResponseWithEndpoint"},"type":"array"}},"type":"object"},"OAuthClient":{"properties":{"clientId":{"description":"The unique OAuth 2.0 client identifier","example":"ABCDEF0123456789","type":"string"},"clientSecret":{"description":"The OAuth 2.0 client secret","example":"ABCDEF0123456789","type":"string"},"description":{"description":"Short description of the application the client is intended to use with","example":"Example description","type":"string"},"name":{"description":"Name of the application the client is intended to use with","example":"Example name","type":"string"},"privacyUrl":{"description":"The privacy policy URL","example":"https://www.example.com/privacy","type":"string"},"redirectUris":{"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","example":["http://*.example.com/*","https://*.example.com/*"],"items":{"type":"string"},"type":"array"},"termsUrl":{"description":"The terms and conditions URL","example":"https://www.example.com/terms","type":"string"},"webOrigins":{"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","example":["http://*.example.com","https://*.example.com"],"items":{"type":"string"},"type":"array"}},"required":["clientId","clientSecret","description","name","privacyUrl","redirectUris","termsUrl","webOrigins"],"title":"OAuthClient","type":"object"},"OAuthClients":{"properties":{"data":{"items":{"$ref":"#/definitions/OAuthClient"},"type":"array"}},"title":"OAuthClients","type":"object"},"OrderSimRequest":{"properties":{"addressId":{"example":"123456","type":"string"}},"required":["addressId"],"type":"object"},"ParallelForwardingResponse":{"properties":{"active":{"default":false,"type":"boolean"},"alias":{"example":"Bjarne Stroustrup's mobile","type":"string"},"destination":{"example":"+4915799912345","type":"string"},"id":{"example":"x0","type":"string"}},"type":"object"},"ParallelForwardingsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/ParallelForwardingResponse"},"type":"array"}},"type":"object"},"Participant":{"properties":{"hold":{"description":"Participant is on hold. Note: for Neo PBX accounts this value is always false.","example":false,"type":"boolean"},"muted":{"description":"Participant is muted. Note: for Neo PBX accounts this value is always false.","example":false,"type":"boolean"},"owner":{"description":"Participant is the call owner","example":false,"type":"boolean"},"participantId":{"description":"The unique participant identifier. Note: for Neo PBX accounts participants are numbered sequentially per call, with the call owner always being participant 1.","example":"ABCDEF0123456789","type":"string"},"phoneNumber":{"description":"Participants phone number. Set to \"<unknown>\" if the phone number is unavailable for various reasons, e.g. anonymous participant.","example":"+4915799912345","type":"string"}},"required":["hold","muted","owner","participantId","phoneNumber"],"type":"object"},"PhonelineBlockAnonymousResponse":{"properties":{"enabled":{"default":false,"type":"boolean"},"target":{"enum":["REJECT","VOICEMAIL"],"type":"string"}},"type":"object"},"PhonelineResponse":{"properties":{"alias":{"example":"Alan Turing","type":"string"},"id":{"example":"p0","type":"string"},"voicemails":{"items":{"$ref":"#/definitions/VoicemailSettingsResponse"},"type":"array"}},"type":"object"},"PhonelineSipgateIoLogResponse":{"properties":{"created":{"example":"2015-10-21T19:28:00Z","type":"string"},"pushApiVersion":{"example":2,"format":"int32","type":"integer"},"request":{"example":"event=newCall&from=492111234567&to=4915791234567&direction=in&callId=123456&user[]=Alice","type":"string"},"response":{"example":"HTTP/1.1 200 OK...","type":"string"},"status":{"example":"200","type":"string"},"url":{"example":"https://demo.sipgate.io","type":"string"},"xmlError":{"example":"Response does not have content type application/xml","type":"string"}},"type":"object"},"PhonelineSipgateIoLogsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/PhonelineSipgateIoLogResponse"},"type":"array"}},"type":"object"},"PhonelineSipgateIoResponse":{"properties":{"allowSelfSigned":{"default":false,"type":"boolean"},"certificate":{"example":"-----BEGIN CERTIFICATE-----","type":"string"},"incomingActive":{"default":false,"type":"boolean"},"incomingUrl":{"example":"https://io.sipgate.beer/my/incoming/url","type":"string"},"log":{"default":false,"type":"boolean"},"outgoingActive":{"default":false,"type":"boolean"},"outgoingUrl":{"example":"https://io.sipgate.rehab/my/outgoing/url","type":"string"}},"type":"object"},"PhonelineVoicemailResponse":{"properties":{"accessNumber":{"example":"50000","type":"string"},"active":{"default":false,"type":"boolean"},"activeGreetingAlias":{"type":"string"},"activeGreetingId":{"type":"string"},"alias":{"example":"Voicemail of Grace Hopper","type":"string"},"canTranscribe":{"default":false,"type":"boolean"},"greetingsUrl":{"type":"string"},"id":{"example":"v0","type":"string"},"timeout":{"example":20,"format":"int32","type":"integer"},"transcription":{"default":false,"type":"boolean"},"transcriptionsUrl":{"type":"string"}},"type":"object"},"PhonelineVoicemailsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/PhonelineVoicemailResponse"},"type":"array"}},"type":"object"},"PlayRecordingRequest":{"properties":{"datadId":{"example":"1000171","type":"string"},"deviceId":{"example":"e0","type":"string"}},"type":"object"},"PortingNumberResponse":{"properties":{"id":{"type":"string"},"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"PortingResponse":{"properties":{"id":{"type":"string"},"numbers":{"items":{"$ref":"#/definitions/PortingNumberResponse"},"type":"array"},"pending":{"default":false,"type":"boolean"},"portDate":{"example":"2015-10-21","type":"string"},"revocable":{"default":false,"type":"boolean"},"status":{"example":200,"format":"int32","type":"integer"}},"type":"object"},"PortingsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/PortingResponse"},"type":"array"}},"type":"object"},"PropertiesResponse":{"properties":{"identityVerificationRequired":{"default":false,"type":"boolean"},"identityVerificationRequiredForMobile":{"default":false,"type":"boolean"},"showNettoPrices":{"default":false,"type":"boolean"},"showSimRelevantOptions":{"default":false,"type":"boolean"}},"type":"object"},"PutStructuredVCardsRequest":{"properties":{"data":{"items":{"$ref":"#/definitions/StructuredVCardUpsertData"},"type":"array"}},"type":"object"},"PutStructuredVCardsResponse":{"properties":{"result":{"items":{"$ref":"#/definitions/ContactsSetResult"},"type":"array"}},"type":"object"},"Recording":{"properties":{"downloadUrl":{"description":"Relative URL for downloading the recording","example":"/v3/channel-files/recording/voicemail/c1/event123","type":"string"},"type":{"description":"The type of recording","enum":["voicemail","in_call_feature","call_recorder"],"type":"string"}},"type":"object"},"RecordingRequest":{"properties":{"announcement":{"description":"Announce recording start/stop to all participants. For Neo PBX accounts, the recording will always be stopped with the same announcement setting as it was started with. When using announcement=false, it is within your responsibility to inform all call participants about the starting/stopping of recordings. Default: true","type":"boolean"},"value":{"description":"Start/stop the recording","example":true,"type":"boolean"}},"required":["value"],"type":"object"},"RegisterDeviceResponse":{"properties":{"activeGroups":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"activePhonelines":{"items":{"$ref":"#/definitions/ActiveRouting"},"type":"array"},"addressUrl":{"example":"/addresses/1234","type":"string"},"alias":{"example":"VoIP phone of Grace Hopper","type":"string"},"credentials":{"$ref":"#/definitions/CredentialsResponse"},"dnd":{"default":false,"type":"boolean"},"emergencyAddressId":{"example":"1234","type":"string"},"id":{"example":"e0","type":"string"},"online":{"default":false,"type":"boolean"},"registered":{"items":{"$ref":"#/definitions/RegisteredDevice"},"type":"array"},"type":{"enum":["REGISTER","MOBILE","EXTERNAL"],"type":"string"}},"type":"object"},"RegisteredDevice":{"properties":{"ip":{"type":"string"},"port":{"type":"string"},"userAgent":{"type":"string"}},"type":"object"},"ReportTarget":{"properties":{"email":{"example":"grace.hopper@example.com","type":"string"},"id":{"example":"42","type":"string"}},"type":"object"},"ResendFaxRequest":{"properties":{"faxId":{"example":"100018428","type":"string"},"faxlineId":{"example":"f0","type":"string"}},"required":["faxId"],"type":"object"},"RestrictionItem":{"properties":{"reason":{"enum":["ADDRESS_HAS_NUMBERS","ADDRESS_NOT_MOVED_YET","ADDRESS_NOT_VERIFIED","BASE_CONTRACT_DOES_NOT_SUPPORT_FEATURE","BUSINESS_VERIFICATION_NOT_COMPLETED","CONTRACT_HAS_NOT_ENOUGH_RIGHTS","HAS_OPEN_PORTING","INTERNAL_ERROR","IS_NOT_ADMIN","LAST_ADDRESS","LAST_VALID_EMERGENCY_ADDRESS"],"type":"string"},"restriction":{"enum":["CAN_CREATE_REGISTER_DEVICE","CAN_DELETE_REGISTER_DEVICE","CAN_CREATE_TRUNK_DEVICE","CAN_DELETE_TRUNK_DEVICE","CAN_BOOK_TRUNKING","CAN_SEE_TRUNKING_CONTINGENT_ADVERTISEMENT","CAN_CREATE_MOBILE_DEVICE","CAN_DELETE_MOBILE_DEVICE","CAN_CREATE_UNLINKED_MOBILE_DEVICE","CAN_DELETE_SIM_DEVICE","CAN_CREATE_EXTERNAL_DEVICE","CAN_DELETE_EXTERNAL_DEVICE","CAN_CHANGE_EXTERNAL_DEVICE","CAN_CREATE_PHONELINE_EXTENSION","CAN_DELETE_PHONELINE_EXTENSION","CAN_CREATE_QUICKDIAL_NUMBER","CAN_CHANGE_QUICKDIAL_NUMBER","CAN_DELETE_QUICKDIAL_NUMBER","CAN_CREATE_FAX_EXTENSION","CAN_DELETE_FAX_EXTENSION","CAN_SEND_FAX","CAN_RECEIVE_FAX","CAN_CHANGE_DEVICE_EMERGENCY_LOCATION","CAN_ACTIVATE_SIM","CAN_GET_ACCOUNT_BALANCE","CAN_USE_AUTOPROVISION","CAN_GET_BLACKLIST","CAN_MANAGE_BLACKLIST","CAN_CHANGE_PHONE_PROVISIONING_CONFIGURATION","CAN_GET_PHONE_PROVISIONING_CONFIGURATION","CAN_ACCOUNT_SEND_WEB_SMS","CAN_ACTIVATE_CALL_RECORDING","CAN_CHANGE_BUSY_ON_BUSY","CAN_CREATE_CRM_INTEGRATION","CAN_CHANGE_CRM_INTEGRATION","CAN_DELETE_CRM_INTEGRATION","CAN_GET_CONTRACTS","CAN_CHANGE_USER_LOCATION","CAN_CHANGE_USER_LOGIN","CAN_CHANGE_USER_ROLE","CAN_CHANGE_USER_NAME","CAN_USE_PBX_FEATURES","CAN_USE_TRUNKS","CAN_CHANGE_CONFERENCE_ROOMS","CAN_USE_CONFERENCE_ROOMS","CAN_CREATE_CONFERENCE_ROOM","CAN_USE_AFFILIATE","CAN_USE_PUSH_API","CAN_CREATE_SHARED_CONTACTS","CAN_USE_SOFTPHONE","CAN_USE_TEAM_CLINQ","CAN_ADD_PHONE_NUMBER","CAN_EDIT_GROUP_SETTINGS","CAN_INDIVIDUALIZE_ACCOUNT","CAN_CREATE_WEBUSER","CAN_CREATE_UNLINKED_DEVICE","CAN_DELETE_UNLINKED_DEVICE","CAN_SEE_PREVIEW_MESSAGES","CAN_CHANGE_FORWARDING_TIMES","CAN_USE_UNLINKED_DEVICES","CAN_USE_GROUPS","CAN_CREATE_GROUP","CAN_USE_WEB_BLF","CAN_CHANGE_VOICEMAIL_SETTINGS","CAN_CREATE_SHARED_VOIP_PHONE_WITHOUT_CHARGE","CAN_CREATE_EXTRA_VOIP_PHONE_WITHOUT_CHARGE","CAN_CREATE_GREETING_FOR_ALL_USERS","CAN_CREATE_CALL_QUEUE","CAN_USE_CALL_QUEUE","CAN_USE_IVR","CAN_CREATE_IVR","CAN_CHANGE_TRUNKS","CAN_USE_SIPGATE_APP","CAN_USE_ACD","CAN_EDIT_ACD_SETTINGS","CAN_CREATE_ADDRESS","CAN_DELETE_ADDRESS","CAN_EDIT_ADDRESS","CAN_MOVE_ADDRESS","CAN_USE_PHONEBOOK_ENTRY","CAN_EDIT_PHONEBOOK_ENTRY","CAN_USE_SAML_SSO","NOTIFICATION_RESTRICTIONS","GSUITE_EXTENSION"],"type":"string"},"target":{"example":"w0","type":"string"},"value":{"type":"object"}},"type":"object"},"RestrictionsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/RestrictionItem"},"type":"array"}},"type":"object"},"RouteDeviceRequest":{"properties":{"deviceId":{"example":"e0","type":"string"}},"required":["deviceId"],"type":"object"},"RoutedEndpointResponse":{"properties":{"endpoint":{"$ref":"#/definitions/EndpointResponse"},"type":{"enum":["FORWARDED","ROUTED","PICKUP"],"type":"string"}},"type":"object"},"SendFaxRequest":{"properties":{"base64Content":{"example":"TWF5IHRoZSBmb3VydGggYmUgd2l0aCB5b3U=","maxLength":28330000,"minLength":0,"type":"string"},"faxlineId":{"example":"f0","type":"string"},"filename":{"example":"fax.pdf","type":"string"},"recipient":{"example":"+4921112345678","type":"string"}},"required":["base64Content","faxlineId","filename","recipient"],"type":"object"},"SendFaxSessionResponse":{"properties":{"sessionId":{"type":"string"}},"type":"object"},"SendWebSmsRequest":{"properties":{"message":{"example":"Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.","type":"string"},"recipient":{"example":"+4915799912345","type":"string"},"sendAt":{"example":1546850272,"format":"int64","type":"integer"},"smsId":{"example":"s0","type":"string"}},"required":["message","recipient","smsId"],"type":"object"},"SetAliasRequest":{"properties":{"alias":{"example":"Theodore Sturgeon's connection","type":"string"}},"type":"object"},"SetBlockAnonymousSettingsRequest":{"properties":{"enabled":{"default":false,"type":"boolean"},"target":{"enum":["REJECT","VOICEMAIL"],"type":"string"}},"type":"object"},"SetBusyOnBusySettingsRequest":{"properties":{"enabled":{"default":false,"type":"boolean"}},"type":"object"},"SetCallRestrictionRequest":{"properties":{"enabled":{"default":false,"example":true,"type":"boolean"}},"type":"object"},"SetDefaultDeviceRequest":{"properties":{"deviceId":{"example":"e0","type":"string"}},"required":["deviceId"],"type":"object"},"SetDeviceAliasRequest":{"properties":{"value":{"example":"Theodore Sturgeon's device","type":"string"}},"type":"object"},"SetDevicesRequest":{"properties":{"deviceIds":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["deviceIds"],"type":"object"},"SetHistoryEntryArchiveRequest":{"properties":{"value":{"default":false,"example":true,"type":"boolean"}},"type":"object"},"SetHistoryEntryNoteRequest":{"properties":{"note":{"type":"string"}},"required":["note"],"type":"object"},"SetHistoryEntryReadRequest":{"properties":{"value":{"default":false,"example":true,"type":"boolean"}},"type":"object"},"SetLocationRequest":{"properties":{"addressId":{"format":"int32","type":"integer"}},"type":"object"},"SetNameRequest":{"properties":{"name":{"type":"string"}},"type":"object"},"SetParallelForwardingRequest":{"properties":{"active":{"default":false,"type":"boolean"},"alias":{"example":"Bjarne Stroustrup's mobile","type":"string"},"destination":{"example":"+4915799912345","type":"string"}},"type":"object"},"SetSipgateIoAccountSettingsRequest":{"properties":{"incomingUrl":{"example":"https://io.sipgate.beer/my/incoming/url","type":"string"},"log":{"default":false,"example":true,"type":"boolean"},"outgoingUrl":{"example":"https://io.sipgate.rehab/my/outgoing/url","type":"string"},"pushApiVersion":{"example":1,"format":"int32","type":"integer"},"whitelist":{"description":"If the whitelist is null or missing, the Push API is activated for the whole account. Neo account do not use groups or phonelines. Therefore, only channel ids are allowed in that case.","example":"[\"w0\", \"w1\", \"g3\"]","items":{"type":"string"},"type":"array"}},"required":["incomingUrl","outgoingUrl"],"type":"object"},"SetSipgateIoPhonelineSettingsRequest":{"properties":{"allowSelfSigned":{"default":false,"type":"boolean"},"certificate":{"example":"-----BEGIN CERTIFICATE-----","type":"string"},"incomingActive":{"default":false,"type":"boolean"},"incomingUrl":{"example":"https://io.sipgate.beer/my/incoming/url","type":"string"},"log":{"default":false,"type":"boolean"},"outgoingActive":{"default":false,"type":"boolean"},"outgoingUrl":{"example":"https://io.sipgate.rehab/my/outgoing/url","type":"string"}},"required":["incomingUrl","outgoingUrl"],"type":"object"},"SetSmsCallerIdRequest":{"properties":{"defaultNumber":{"default":false,"type":"boolean"}},"type":"object"},"SetUsersRequest":{"properties":{"userIds":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["userIds"],"type":"object"},"SimpleGroupResponse":{"properties":{"alias":{"example":"Turings Group","type":"string"},"departmentId":{"format":"int64","type":"integer"},"groupNumbersUrl":{"type":"string"},"groupUsersUrl":{"type":"string"},"id":{"example":"g0","type":"string"}},"type":"object"},"SimpleGroupsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/SimpleGroupResponse"},"type":"array"}},"type":"object"},"SimplePhonelineResponse":{"properties":{"alias":{"example":"Alan Turing","type":"string"},"blockAnonymousUrl":{"type":"string"},"devicesUrl":{"type":"string"},"forwardingsUrl":{"type":"string"},"id":{"example":"p0","type":"string"},"numbersUrl":{"type":"string"},"parallelForwardingsUrl":{"type":"string"},"voicemailsUrl":{"type":"string"}},"type":"object"},"SimplePhonelinesResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/SimplePhonelineResponse"},"type":"array"}},"type":"object"},"SimpleVoicemailResponse":{"properties":{"alias":{"example":"Voicemail of Grace Hopper","type":"string"},"belongsToEndpoint":{"$ref":"#/definitions/EndpointResponse"},"id":{"example":"v0","type":"string"}},"type":"object"},"SingleRowDisplayRequest":{"properties":{"enabled":{"default":false,"type":"boolean"}},"type":"object"},"SingleRowDisplayResponse":{"properties":{"enabled":{"default":false,"type":"boolean"}},"type":"object"},"SipgateIoUrlResponse":{"properties":{"incomingUrl":{"example":"https://io.sipgate.beer/my/incoming/url","type":"string"},"log":{"default":false,"example":true,"type":"boolean"},"outgoingUrl":{"example":"https://io.sipgate.rehab/my/outgoing/url","type":"string"},"pushApiVersion":{"example":1,"format":"int32","type":"integer"},"pushApiVersionLifecycle":{"example":"STABLE","readOnly":true,"type":"string"},"whitelist":{"example":"[w0]","items":{"type":"string"},"type":"array"}},"type":"object"},"SmsCallerIdRequest":{"properties":{"phonenumber":{"example":"+4915799912345","type":"string"}},"type":"object"},"SmsCallerIdResponse":{"properties":{"defaultNumber":{"default":false,"type":"boolean"},"id":{"format":"int32","type":"integer"},"phonenumber":{"type":"string"},"verified":{"default":false,"type":"boolean"}},"type":"object"},"SmsCallerIdsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/SmsCallerIdResponse"},"type":"array"}},"type":"object"},"SmsEmailTarget":{"properties":{"direction":{"enum":["INCOMING","OUTGOING"],"type":"string"},"email":{"example":"grace.hopper@example.com","type":"string"},"id":{"example":"42","type":"string"}},"type":"object"},"SmsExtensionResponse":{"properties":{"alias":{"example":"SMS von Douglas Engelbart","type":"string"},"callerId":{"example":"+4915799912345","type":"string"},"id":{"example":"s0","type":"string"}},"type":"object"},"SmsExtensionsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/SmsExtensionResponse"},"type":"array"}},"type":"object"},"SmsNotificationResponse":{"properties":{"emails":{"items":{"$ref":"#/definitions/SmsEmailTarget"},"type":"array"},"endpointAlias":{"example":"Fax/Voicemail of Grace Hopper","type":"string"},"endpointId":{"example":"f0/v0/p0","type":"string"}},"type":"object"},"SmsTarget":{"properties":{"id":{"example":"1337","type":"string"},"number":{"example":"+4915799912345","type":"string"}},"type":"object"},"StreamingResponseBody":{"type":"object"},"StructuredVCard":{"properties":{"items":{"additionalProperties":{"items":{"$ref":"#/definitions/StructuredVCardItem"},"type":"array"},"type":"object"},"meta":{"$ref":"#/definitions/StructuredVCardMeta"}},"type":"object"},"StructuredVCardItem":{"properties":{"city":{"type":"string"},"country":{"type":"string"},"extended":{"type":"string"},"family":{"type":"string"},"given":{"type":"string"},"group":{"type":"string"},"lat":{"type":"string"},"long":{"type":"string"},"middle":{"type":"string"},"name":{"type":"string"},"po_box":{"type":"string"},"post_code":{"type":"string"},"prefixes":{"type":"string"},"region":{"type":"string"},"street":{"type":"string"},"suffixes":{"type":"string"},"types":{"items":{"type":"string"},"type":"array"},"unit":{"items":{"type":"string"},"type":"array"},"value":{"type":"string"},"x-local-number":{"type":"string"},"xlocalNumber":{"type":"string"}},"type":"object"},"StructuredVCardMeta":{"properties":{"UUID":{"type":"string"},"owner":{"type":"string"},"valid_from":{"type":"string"},"valid_thru":{"type":"string"}},"type":"object"},"StructuredVCardUpsertData":{"properties":{"contactId":{"type":"string"},"item":{"additionalProperties":{"items":{"$ref":"#/definitions/StructuredVCardItem"},"type":"array"},"type":"object"}},"type":"object"},"TacResponse":{"properties":{"accepted":{"default":false,"type":"boolean"}},"type":"object"},"TariffAnnouncementRequest":{"properties":{"enabled":{"default":false,"type":"boolean"}},"type":"object"},"TariffAnnouncementResponse":{"properties":{"enabled":{"default":false,"type":"boolean"}},"type":"object"},"TransferRequest":{"properties":{"attended":{"description":"The transfer is attended or blind","example":false,"type":"boolean"},"callerId":{"description":"Caller phone number","example":"+492110012345","type":"string"},"phoneNumber":{"description":"Transfer target phone number","example":"+4915799912345","type":"string"}},"required":["attended","phoneNumber"],"type":"object"},"UpdateContactRequest":{"properties":{"addresses":{"items":{"$ref":"#/definitions/AddressRequest"},"type":"array"},"emails":{"items":{"$ref":"#/definitions/EmailRequest"},"type":"array"},"family":{"example":"Lovelace","type":"string"},"given":{"example":"Ada","type":"string"},"id":{"example":"80d6bf52-5497-4c05-9ab6-076a377c92b7","type":"string"},"name":{"example":"Ada Lovelace","type":"string"},"note":{"type":"string"},"numbers":{"items":{"$ref":"#/definitions/NumberRequest"},"type":"array"},"organization":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"picture":{"example":"4AAQSkZJRgABAQAAAQABAAD...","type":"string"},"scope":{"enum":["PRIVATE","SHARED","INTERNAL","PRIVATE,SHARED"],"example":"PRIVATE","type":"string"},"websites":{"items":{"$ref":"#/definitions/WebsiteRequest"},"type":"array"}},"type":"object"},"UpdateExtensionSettingsRequest":{"properties":{"active":{"type":"boolean"}},"type":"object"},"UpdateHistoryEntriesRequest":{"properties":{"archived":{"default":false,"type":"boolean"},"id":{"type":"string"},"read":{"default":false,"type":"boolean"},"starred":{"default":false,"type":"boolean"}},"required":["id"],"type":"object"},"UpdateHistoryEntryRequest":{"properties":{"archived":{"default":false,"type":"boolean"},"note":{"type":"string"},"read":{"default":false,"type":"boolean"},"starred":{"default":false,"type":"boolean"}},"type":"object"},"UserResponse":{"properties":{"addressId":{"example":"13","type":"string"},"admin":{"default":false,"type":"boolean"},"affiliateLogin":{"default":false,"type":"boolean"},"busyOnBusy":{"default":false,"example":true,"type":"boolean"},"defaultDevice":{"example":"e0","type":"string"},"directDialIds":{"example":"101","items":{"type":"string"},"type":"array"},"email":{"example":"ada.lovelace@sipgate.love","type":"string"},"firstname":{"example":"Ada","type":"string"},"id":{"example":"w0","type":"string"},"lastname":{"example":"Lovelace","type":"string"},"timezone":{"example":"Europe/Berlin","type":"string"}},"type":"object"},"UserinfoResponse":{"properties":{"domain":{"example":"sipgate.de","type":"string"},"locale":{"example":"de_DE","type":"string"},"masterSipId":{"example":"0000000","type":"string"},"sub":{"example":"w0","type":"string"}},"type":"object"},"UsersResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/UserResponse"},"type":"array"}},"type":"object"},"VerifySmsCallerIdRequest":{"properties":{"verificationCode":{"type":"string"}},"type":"object"},"VoicemailNotificationResponse":{"properties":{"emails":{"items":{"$ref":"#/definitions/EmailTarget"},"type":"array"},"endpointAlias":{"example":"Fax/Voicemail of Grace Hopper","type":"string"},"endpointId":{"example":"f0/v0/p0","type":"string"},"sms":{"items":{"$ref":"#/definitions/SmsTarget"},"type":"array"}},"type":"object"},"VoicemailResponse":{"properties":{"accessNumber":{"example":"50000","type":"string"},"activeGreetingAlias":{"type":"string"},"activeGreetingId":{"type":"string"},"alias":{"example":"Voicemail of Grace Hopper","type":"string"},"belongsToEndpoint":{"$ref":"#/definitions/EndpointResponse"},"canTranscribe":{"default":false,"type":"boolean"},"id":{"example":"v0","type":"string"},"transcription":{"default":false,"type":"boolean"}},"type":"object"},"VoicemailSettingsResponse":{"properties":{"active":{"default":false,"type":"boolean"},"id":{"example":"p0","type":"string"},"timeout":{"example":10,"format":"int32","type":"integer"}},"type":"object"},"VoicemailsResponse":{"properties":{"items":{"items":{"$ref":"#/definitions/SimpleVoicemailResponse"},"type":"array"}},"type":"object"},"WebsiteRequest":{"properties":{"type":{"items":{"type":"string"},"type":"array"},"url":{"example":"example.com","type":"string"}},"type":"object"},"WebsiteResponse":{"properties":{"type":{"items":{"type":"string"},"type":"array"},"url":{"example":"example.com","type":"string"}},"type":"object"}},"host":"api.sipgate.com","info":{"description":"This is the sipgate REST API documentation. We build our applications on this API and we invite you to use it too.","title":"sipgate API","version":"2.0.0"},"paths":{"/":{"get":{"description":"","operationId":"getUrls","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUrlsResponse"}}},"summary":"Get all top level API URLs","tags":["urls"]}},"/account":{"get":{"description":"","operationId":"getAccount","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountResponse"}},"404":{"description":"Account not found"}},"security":[{"oauth2":["all","account:read"]}],"summary":"Get account data","tags":["account"]}},"/account/verified":{"put":{"description":"","operationId":"verify","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AccountVerificationRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Verification code not found"}},"security":[{"oauth2":["all","account:write"]}],"summary":"Verify your account","tags":["account"]}},"/addresses":{"get":{"description":"","operationId":"getAddresses","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AddressesResponse"}}},"security":[{"oauth2":["all","addresses:read"]}],"summary":"List all addresses","tags":["addresses"]}},"/addresses/itemCount":{"get":{"description":"","operationId":"getItemCount","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ItemCountResponse"}}},"security":[{"oauth2":["all","addresses:read"]}],"summary":"Get amount of addresses","tags":["addresses"]}},"/addresses/{addressId}":{"get":{"description":"","operationId":"getAddress","parameters":[{"description":"The unique address identifier","format":"int32","in":"path","name":"addressId","required":true,"type":"integer","x-example":123}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AddressResponse"}}},"security":[{"oauth2":["all","addresses:read"]}],"summary":"Get a specific address","tags":["addresses"]},"put":{"description":"<strong>Warning:</strong> Depending on your country of residence, a change of your address may lead to the deactivation of associated telephone numbers.","operationId":"modifyAddress","parameters":[{"description":"The unique address identifier","format":"int32","in":"path","name":"addressId","required":true,"type":"integer","x-example":123},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ModifyAddressRequest"}}],"produces":["application/json"],"responses":{"400":{"description":"Bad request"}},"security":[{"oauth2":["all","addresses:write"]}],"summary":"Update an existing address","tags":["addresses"]}},"/addresses/{addressId}/numbers":{"get":{"description":"","operationId":"getAddressNumbers","parameters":[{"description":"The unique address identifier","format":"int32","in":"path","name":"addressId","required":true,"type":"integer","x-example":123}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}],"summary":"List all phone numbers of a specific address","tags":["addresses"]}},"/app/events":{"get":{"description":"","operationId":"getEvents","parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventsResponse"}}},"security":[{"oauth2":["internal"]}],"summary":"List all active events for this account","tags":["app"]}},"/app/events/{id}":{"delete":{"description":"","operationId":"deleteEvent","parameters":[{"format":"int32","in":"path","name":"id","required":true,"type":"integer"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventsResponse"}}},"security":[{"oauth2":["internal"]}],"summary":"Delete a specific event","tags":["app"]}},"/app/links":{"get":{"description":"","operationId":"getLinks","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LinksResponse"}}},"summary":"List all external URLs of app.sipgate.com","tags":["app"]}},"/app/properties":{"get":{"description":"","operationId":"getProperties","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PropertiesResponse"}}},"security":[{"oauth2":["all","internal"]}],"summary":"List all properties of app.sipgate.com","tags":["app"]}},"/app/tacs":{"get":{"description":"","operationId":"getTac","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TacResponse"}}},"security":[{"oauth2":["internal"]}],"summary":"Check if terms and conditions have been accepted","tags":["app"]}},"/app/users":{"get":{"description":"","operationId":"getUsers","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersResponse"}}},"security":[{"oauth2":["internal"]}],"summary":"Fetch all users with numbers, addresses and call restrictions","tags":["app"]}},"/authorization/oauth2/clients":{"get":{"operationId":"getClients","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClients"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:read"]}],"summary":"List all OAuth 2.0 clients","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"},"post":{"operationId":"createClient","parameters":[{"in":"body","name":"client","required":true,"schema":{"properties":{"description":{"description":"Short description of the application the client is intended to use with","example":"Example description","type":"string"},"name":{"description":"Name of the application the client is intended to use with","example":"Example name","type":"string"},"privacyUrl":{"description":"The privacy policy URL","example":"https://www.example.com/privacy","type":"string"},"redirectUris":{"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","example":["https://*.example.com/*"],"items":{"type":"string"},"type":"array"},"termsUrl":{"description":"The terms and conditions URL","example":"https://www.example.com/terms","type":"string"},"webOrigins":{"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","example":["http://*.example.com","https://*.example.com"],"items":{"type":"string"},"type":"array"}},"required":["description","name","privacyUrl","redirectUris","termsUrl","webOrigins"]}}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"summary":"Create a new OAuth 2.0 client","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"}},"/authorization/oauth2/clients/{clientId}":{"delete":{"operationId":"deleteClient","parameters":[{"description":"The unique OAuth 2.0 client identifier","in":"path","name":"clientId","required":true,"type":"string"}],"responses":{"202":{"description":"Deletion request accepted"}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"summary":"Delete an existing OAuth 2.0 client","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"},"get":{"operationId":"getClient","parameters":[{"description":"The unique OAuth 2.0 client identifier","in":"path","name":"clientId","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:read"]}],"summary":"Get a specific OAuth 2.0 client","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"},"put":{"operationId":"updateClient","parameters":[{"description":"The unique OAuth 2.0 client identifier","in":"path","name":"clientId","required":true,"type":"string"},{"in":"body","name":"client","required":true,"schema":{"properties":{"description":{"description":"Short description of the application the client is intended to use with","example":"Example description","type":"string"},"name":{"description":"Name of the application the client is intended to use with","example":"Example name","type":"string"},"privacyUrl":{"description":"The privacy policy URL","example":"https://www.example.com/privacy","type":"string"},"redirectUris":{"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","example":["https://*.example.com/*"],"items":{"type":"string"},"type":"array"},"termsUrl":{"description":"The terms and conditions URL","example":"https://www.example.com/terms","type":"string"},"webOrigins":{"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","example":["http://*.example.com","https://*.example.com"],"items":{"type":"string"},"type":"array"}},"required":["description","name","privacyUrl","redirectUris","termsUrl","webOrigins"]}}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"summary":"Update an existing OAuth 2.0 client","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"}},"/authorization/oauth2/clients/{clientId}/gdpr":{"get":{"operationId":"getGdprUrls","parameters":[{"description":"The unique OAuth 2.0 client identifier","in":"path","name":"clientId","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/GdprUrls"}}},"summary":"Get GDPR urls for specific OAuth 2.0 client","tags":["authorization"],"x-accepts":"application/json","x-contentType":"application/json"}},"/authorization/userinfo":{"get":{"description":"","operationId":"userinfo","parameters":[{"description":"Basic <base64 token>","in":"header","name":"Authorization","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserinfoResponse"}},"401":{"description":"Invalid token supplied"}},"summary":"Get information about the logged in user","tags":["authorization"]}},"/autorecordings/greetings":{"get":{"description":"Returns the current greeting for automated call recordings. Requires admin privileges and an activated call recording account.","operationId":"getGreeting","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/GreetingResponse"}}},"security":[{"oauth2":["autorecording:greeting:read","all"]}],"summary":"Fetch the current automated call recording greeting","tags":["autorecordings"]},"post":{"consumes":["application/json"],"description":"Replaces the current greeting with the provided audio file. Requires admin privileges and an activated call recording account.","operationId":"addGreeting","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/AddGreetingRequest"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["autorecording:greeting:write","all"]}],"summary":"Save a greeting to be used for automated call recordings","tags":["autorecordings"]}},"/autorecordings/greetings/{greetingId}":{"delete":{"description":"Deletes the specified greeting. Requires admin privileges and an activated call recording account.","operationId":"deleteGreeting","parameters":[{"description":"The unique greeting identifier","in":"path","name":"greetingId","required":true,"type":"string","x-example":42}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["autorecording:greeting:write","all"]}],"summary":"Delete the greeting used for automated call recordings","tags":["autorecordings"]}},"/autorecordings/{extension}/settings":{"get":{"description":"Get recording settings for an endpoint. Currently only register endpoints are supported. The masterSipId is derived from the authenticated webuser context and doesn't need to be provided in the request. Returns 200 OK with the recording settings on success, 400 Bad Request if the request is invalid, and 404 Not Found if the extension does not exist or call recording is not activated for the account.","operationId":"getRecordingSettingForEndpoint","parameters":[{"in":"path","name":"extension","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ExtensionSettingsResponse"}}},"security":[{"oauth2":["devices:read","all"]}],"summary":"Get recording settings for an endpoint","tags":["autorecordings"]},"put":{"consumes":["application/json"],"description":"Update recording settings for an endpoint. Currently only register endpoints are supported. The masterSipId is derived from the authenticated webuser context and doesn't need to be provided in the request. Returns 204 No Content on success, 400 Bad Request if the request is invalid, and 404 Not Found if the extension does not exist or call recording is not activated for the account.","operationId":"updateRecordingSettingForEndpoint","parameters":[{"in":"path","name":"extension","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/UpdateExtensionSettingsRequest"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["devices:read","all"]}],"summary":"Update recording settings for an endpoint","tags":["autorecordings"]}},"/balance":{"get":{"description":"","operationId":"getBalance","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BalanceResponse"}}},"security":[{"oauth2":["all","balance:read"]}],"summary":"Get the account balance","tags":["account"]}},"/blacklist/incoming":{"get":{"consumes":["application/json"],"description":"","operationId":"getIncomingEntries","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IncomingEntries"}}},"security":[{"oauth2":["all","blacklist:read"]}],"summary":"Get your incoming blacklist entries","tags":["blacklist"]},"post":{"consumes":["application/json"],"description":"","operationId":"addIncomingEntry","parameters":[{"description":"Incoming blacklist entry. Recommended request format for phoneNumber is E.164 format without leading +. Entries are stored with a leading + and returned that way. Do not use national numbers with leading 0, e.g. use 49151... instead of 0151....","in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IncomingEntry"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IncomingEntry"}},"201":{"description":"successful operation","schema":{"$ref":"#/definitions/IncomingEntry"}},"400":{"description":"Invalid phoneNumber supplied","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"IncomingEntry already exists","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"oauth2":["all","blacklist:write"]}],"summary":"Create a new incoming blacklist entry","tags":["blacklist"]}},"/blacklist/incoming/{phoneNumber}":{"delete":{"consumes":["application/json"],"description":"Recommended request format for phoneNumber is E.164 format without leading +, e.g. 492117654321. Entries are stored with a leading +. Do not use national numbers with leading 0, e.g. use 49151... instead of 0151....","operationId":"removeIncomingEntry","parameters":[{"in":"path","name":"phoneNumber","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"successful operation"},"400":{"description":"Invalid phoneNumber supplied","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"IncomingEntry not found","schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"oauth2":["all","blacklist:write"]}],"summary":"Delete an incoming blacklist entry","tags":["blacklist"]}},"/callrestrictions":{"get":{"description":"","operationId":"getCallRestrictions","parameters":[{"collectionFormat":"multi","description":"List of extensions","in":"query","items":{"type":"string"},"name":"userIds","required":false,"type":"array"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallRestrictionResponse"}},"404":{"description":"User not found"}},"security":[{"oauth2":["all","callrestrictions:read"]}],"summary":"Get call restrictions data","tags":["callrestrictions"]}},"/calls":{"get":{"consumes":["application/json"],"description":"Note: for Neo PBX accounts the values for muted and hold are always false.","operationId":"getCalls","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Calls"}},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","rtcm:read"]}],"summary":"List all currently established calls. The response does not contain ringing calls or currently running voicemail recordings.","tags":["rtcm"]},"post":{"consumes":["application/json"],"description":"","operationId":"createCall","parameters":[{"description":"call parameters","in":"body","name":"body","schema":{"properties":{"additionalDevices":{"description":"Optional additional local devices that should ring simultaneously. The call ends for all devices once the first one answers.","items":{"properties":{"deviceId":{"description":"The local device that should ring in addition to the primary device.","example":"e1","type":"string"}},"required":["deviceId"],"type":"object"},"type":"array"},"callerId":{"description":"The caller ID displayed to the remote party.","example":"4915790123456","type":"string"},"channelId":{"description":"The channel ID to use for the call. If not provided, the call will be started from the device's default channel.","example":"0982524d-1328-4830-89d8-a295f200e90e","type":"string"},"deviceId":{"description":"The local device with which the call is to be established.","example":"e0","type":"string"},"targetNumber":{"description":"The phone number of the remote party. May also be an internal extension (short code, e.g. 667), which is resolved to the configured target endpoint.","example":"4915790123456","type":"string"}},"required":["deviceId","targetNumber"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Call initiated successfully","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"Invalid request parameters"},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Start a new channel call for sipgate neo accounts","tags":["rtcm"]}},"/calls/{callId}":{"delete":{"consumes":["application/json"],"description":"","operationId":"hangupCall","parameters":[{"in":"path","name":"callId","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Hang up call","tags":["rtcm"]}},"/calls/{callId}/announcements":{"post":{"consumes":["application/json"],"description":"Note: This functionality is not available for Neo PBX accounts. Currently the sound file needs to be a mono 16bit PCM WAV file with a sampling rate of 8kHz. MP3 conversion example: mpg123 --rate 8000 --mono -w output.wav input.mp3","operationId":"startCallAnnouncement","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AnnouncementRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Start playing a new announcement to all participants","tags":["rtcm"]}},"/calls/{callId}/dtmf":{"post":{"consumes":["application/json"],"description":"","operationId":"sendCallDtmf","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DtmfRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Send DTMF tone sequences to all participants","tags":["rtcm"]}},"/calls/{callId}/hold":{"put":{"consumes":["application/json"],"description":"","operationId":"setCallHold","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BooleanRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"},"409":{"description":"Call not yet established"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Hold/Resume all participants","tags":["rtcm"]}},"/calls/{callId}/muted":{"put":{"consumes":["application/json"],"description":"Note: This functionality is not available for Neo PBX accounts.","operationId":"setCallMuted","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BooleanRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Mute/Unmute yourself","tags":["rtcm"]}},"/calls/{callId}/recording":{"put":{"consumes":["application/json"],"description":"When starting a recording with announcement=false, no announcement will be played to call participants. It is within your responsibility to inform all call participants about the recording. For Neo PBX accounts, the recording will always be stopped with the same announcement setting as it was started with.","operationId":"setCallRecording","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RecordingRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Start or stop a call recording","tags":["rtcm"]}},"/calls/{callId}/transfer":{"post":{"consumes":["application/json"],"description":"","operationId":"transferCall","parameters":[{"in":"path","name":"callId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"produces":["application/json"],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"404":{"description":"Call not found"},"409":{"description":"Call is still being established"}},"security":[{"oauth2":["all","rtcm:write"]}],"summary":"Transfer call","tags":["rtcm"]}},"/channels":{"get":{"operationId":"listChannels","responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelListResponse"}}},"security":[{"oauth2":["all","channels:read"]}],"summary":"List channels","tags":["channels"]}},"/channels/{channelId}":{"delete":{"operationId":"deleteChannel","parameters":[{"format":"uuid","in":"path","name":"channelId","required":true,"type":"string"}],"responses":{"204":{"description":"No Content"}},"security":[{"oauth2":["all","channels:write"]}],"summary":"Delete a channel","tags":["channels"]}},"/channels/{channelId}/events":{"get":{"operationId":"getChannelEvents","parameters":[{"in":"path","name":"channelId","required":true,"type":"string"},{"in":"query","name":"position","required":false,"type":"string"},{"default":50,"format":"int32","in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelInbox"}}},"security":[{"oauth2":["all","channels:read"]}],"summary":"Get channel inbox events for a specific channel","tags":["channels"]}},"/channels/{channelId}/name":{"put":{"operationId":"setChannelName","parameters":[{"format":"uuid","in":"path","name":"channelId","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SetNameRequest"}}],"responses":{"204":{"description":"No Content"}},"security":[{"oauth2":["all","channels:write"]}],"summary":"Set the name of a channel","tags":["channels"]}},"/channels/{channelId}/users":{"put":{"operationId":"setUsers","parameters":[{"format":"uuid","in":"path","name":"channelId","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SetUsersRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ChannelUsersResponse"}}},"security":[{"oauth2":["all","channels:write"]}],"summary":"Set users of the channel","tags":["channels"]}},"/channels/{channelId}/users/{userId}/devices":{"put":{"operationId":"setUserDevices","parameters":[{"format":"uuid","in":"path","name":"channelId","required":true,"type":"string"},{"in":"path","name":"userId","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SetDevicesRequest"}}],"responses":{"204":{"description":"No Content"}},"security":[{"oauth2":["all","channels:write"]}],"summary":"Set the list of devices for a user.","tags":["channels"]}},"/contacts":{"delete":{"consumes":["application/json"],"operationId":"deleteContacts","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/DeleteRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"Contacts deleted","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"400":{"description":"Invalid request","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/DeleteContactResponse"}}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Delete all or specified contacts of specified user or shared contacts","tags":["contacts"]},"get":{"operationId":"getContacts_1","parameters":[{"collectionFormat":"multi","description":"Filter contacts by phonenumbers","in":"query","items":{"type":"string"},"name":"phonenumbers","required":false,"type":"array"},{"default":5000,"description":"Limit result rows","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"deprecated":true,"description":"The offset used for pagination. Please use lastId instead.","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"The last contact-id of the previous page","in":"query","name":"lastId","required":false,"type":"string"},{"collectionFormat":"multi","default":[],"description":"Included contacts scopes, if missing all are included","in":"query","items":{"enum":["PRIVATE","SHARED","INTERNAL"],"type":"string"},"name":"scopes","required":false,"type":"array","uniqueItems":true}],"produces":["application/json"],"responses":{"200":{"description":"Contacts retrieved successfully","schema":{"$ref":"#/definitions/ContactsResponse"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/ContactsResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ContactsResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ContactsResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/ContactsResponse"}}},"security":[{"oauth2":["all","contacts:read"]}],"summary":"Get all contacts","tags":["contacts"]},"post":{"consumes":["application/json"],"operationId":"createContact","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/CreateContactRequest"}}],"responses":{"201":{"description":"Contact created successfully"},"400":{"description":"Invalid request or invalid vCard data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"422":{"description":"Unprocessable entity - invalid scope"},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Creates a contact","tags":["contacts"]}},"/contacts/csv":{"get":{"operationId":"getContactsAsCsv","parameters":[{"collectionFormat":"multi","description":"Scope of the request","in":"query","items":{"enum":["PRIVATE","SHARED","INTERNAL"],"type":"string"},"name":"scope","required":true,"type":"array","x-example":"SHARED"}],"produces":["text/csv"],"responses":{"200":{"description":"CSV export successful","schema":{"type":"string"}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/StreamingResponseBody"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/StreamingResponseBody"}}},"security":[{"oauth2":["all","contacts:read"]}],"summary":"Call this to get contacts in csv format. ","tags":["contacts"]}},"/contacts/import/csv":{"post":{"consumes":["application/json"],"description":"CSV files should match the following format:<br />\n<pre>\nfirstname,lastname,number\nAda,Lovelace,+4915799912345\nAlan,Turing,+4915799912345\n</pre>","operationId":"importFromCSV","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportCSVRequest"}}],"responses":{"204":{"description":"CSV imported successfully"},"400":{"description":"Invalid CSV format or data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Import contacts from CSV file","tags":["contacts"]}},"/contacts/import/google":{"post":{"consumes":["application/json"],"operationId":"importFromGoogle","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ImportGoogleRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"Google contacts imported successfully","schema":{"$ref":"#/definitions/ImportGoogleResponse"}},"400":{"description":"Invalid token or request","schema":{"$ref":"#/definitions/ImportGoogleResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ImportGoogleResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ImportGoogleResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/ImportGoogleResponse"}}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Import contacts from Google","tags":["contacts"]}},"/contacts/internal":{"get":{"deprecated":true,"description":"","operationId":"getAllContacts","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InternalContactsResponse"}}},"security":[{"oauth2":["all","contacts:read"]}],"summary":"DEPRECATED use /v2/contacts?scopes=INTERNAL","tags":["contacts"]}},"/contacts/vcard":{"get":{"operationId":"getContacts","parameters":[{"collectionFormat":"multi","description":"Scope of the request","in":"query","items":{"enum":["PRIVATE","SHARED","INTERNAL"],"type":"string"},"name":"scope","required":true,"type":"array","x-example":"SHARED"},{"collectionFormat":"multi","description":"Filter contacts by label","in":"query","items":{"type":"string"},"name":"labels","required":false,"type":"array"},{"collectionFormat":"multi","description":"Return specific contacts by ID","in":"query","items":{"type":"string"},"name":"contactIds","required":false,"type":"array"},{"collectionFormat":"multi","description":"Specify fields to return, in order to reduce response size","in":"query","items":{"type":"string"},"name":"wantedFields","required":false,"type":"array"},{"description":"Filter contacts by search term","in":"query","name":"filter","required":false,"type":"string"},{"default":5000,"description":"Limit result rows","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"deprecated":true,"description":"The offset used for pagination. Please use lastId instead.","format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"description":"The last Contact-ID of the previous page","in":"query","name":"lastId","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Contacts exported as raw vCards successfully","schema":{}},"400":{"description":"Invalid parameters","schema":{"$ref":"#/definitions/GetStructuredVCardsResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/GetStructuredVCardsResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/GetStructuredVCardsResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/GetStructuredVCardsResponse"}}},"security":[{"oauth2":["all","contacts:read"]}],"summary":"Call this to get contacts in raw vCard format. ","tags":["contacts"]},"put":{"consumes":["application/json"],"operationId":"addOrUpdateContacts","parameters":[{"description":"Scope of the request","enum":["PRIVATE","SHARED","INTERNAL"],"in":"query","name":"scope","required":true,"type":"string","x-example":"SHARED"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PutStructuredVCardsRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"Contacts added or updated successfully","schema":{"$ref":"#/definitions/PutStructuredVCardsResponse"}},"400":{"description":"Invalid request or empty data","schema":{"$ref":"#/definitions/PutStructuredVCardsResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/PutStructuredVCardsResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/PutStructuredVCardsResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/PutStructuredVCardsResponse"}}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Store one or more contacts. If \"contactId\" is provided it must match an existing contact, which will be overwritten. To add contacts an empty \"contactId\" is to be provided. ","tags":["contacts"]}},"/contacts/{contactId}":{"get":{"operationId":"getContactById","parameters":[{"in":"path","name":"contactId","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Contact retrieved successfully","schema":{"$ref":"#/definitions/ContactResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ContactResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ContactResponse"}},"404":{"description":"Contact not found","schema":{"$ref":"#/definitions/ContactResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/ContactResponse"}}},"security":[{"oauth2":["all","contacts:read"]}],"summary":"Get contacts by id","tags":["contacts"]},"put":{"consumes":["application/json"],"operationId":"updateContact","parameters":[{"in":"path","name":"contactId","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/UpdateContactRequest"}}],"responses":{"204":{"description":"Contact updated successfully"},"400":{"description":"Invalid request or contactId mismatch"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Contact not found"},"422":{"description":"Unprocessable entity - invalid scope"},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Updates a contact","tags":["contacts"]}},"/contacts/{contactid}":{"delete":{"operationId":"deleteContact","parameters":[{"in":"path","name":"contactid","required":true,"type":"string"},{"collectionFormat":"multi","default":["SHARED","PRIVATE"],"in":"query","items":{"enum":["PRIVATE","SHARED","INTERNAL"],"type":"string"},"name":"scope","required":false,"type":"array"}],"produces":["application/json"],"responses":{"200":{"description":"Contact deleted successfully","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"404":{"description":"Contact not found","schema":{"$ref":"#/definitions/DeleteContactResponse"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/DeleteContactResponse"}}},"security":[{"oauth2":["all","contacts:write"]}],"summary":"Delete a single contact","tags":["contacts"]}},"/devices/{deviceId}":{"delete":{"description":"","operationId":"deleteDevice","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"403":{"description":"This operation is not supported for app extensions."}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Delete an existing device","tags":["devices"]},"get":{"description":"","operationId":"getDevice","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceResponse"}}},"security":[{"oauth2":["all","devices:read"]}],"summary":"Get a specific device","tags":["devices"]},"put":{"description":"","operationId":"changeDeviceSettings","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeDeviceRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Update settings for an existing device","tags":["devices"]}},"/devices/{deviceId}/alias":{"put":{"description":"","operationId":"changeDeviceAlias","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetDeviceAliasRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Device not found"}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Update alias for an existing device","tags":["devices"]}},"/devices/{deviceId}/callerid":{"get":{"description":"","operationId":"getCallerId","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallerIdResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:read","devices:callerid:read"]}],"summary":"Get the caller ID of a specific device","tags":["devices"]},"put":{"description":"","operationId":"changeCallerIdSettings","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallerIdRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:write","devices:callerid:write"]}],"summary":"Update the caller ID for an existing device","tags":["devices"]}},"/devices/{deviceId}/credentials/password":{"post":{"description":"","operationId":"changeDevicePassword","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"403":{"description":"This operation is not supported for app extensions."}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Change password for an existing device","tags":["devices"]}},"/devices/{deviceId}/external/incomingcalldisplay":{"put":{"description":"","operationId":"changeCallerDisplayOfDevice","parameters":[{"description":"The unique external device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"x0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeExternalDeviceIncomingCallDisplayRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Update the incoming call display for an existing external device","tags":["devices"]}},"/devices/{deviceId}/external/targetnumber":{"put":{"description":"","operationId":"changeTargetNumberOfDevice","parameters":[{"description":"The unique external device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"x0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeExternalDeviceTargetNumberRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Update the target phone number for an existing external device","tags":["devices"]}},"/devices/{deviceId}/localprefix":{"get":{"description":"","operationId":"getLocalprefix","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalprefixResponse"}}},"security":[{"oauth2":["all","devices:read","devices:localprefix:read"]}],"summary":"Get the local prefix setting of a specific device","tags":["devices"]},"put":{"description":"","operationId":"changeLocalprefixSettings","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LocalprefixRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:localprefix:write"]}],"summary":"Update the local prefix setting for an existing device","tags":["devices"]}},"/devices/{deviceId}/singlerowdisplay":{"get":{"description":"","operationId":"getSingleRowDisplay","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleRowDisplayResponse"}}},"security":[{"oauth2":["all","devices:read","devices:singlerowdisplay:read"]}],"summary":"Get single row display setting of a specific device","tags":["devices"]},"put":{"description":"","operationId":"changeSingleRowDisplay","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SingleRowDisplayRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:singlerowdisplay:write"]}],"summary":"Update single row display setting for an existing device","tags":["devices"]}},"/devices/{deviceId}/tariffannouncement":{"get":{"description":"","operationId":"getTariffAnnouncement","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TariffAnnouncementResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:read","devices:tariffannouncement:read"]}],"summary":"Get tariff announcement setting of a specific device","tags":["devices"]},"put":{"description":"","operationId":"changeTariffAnnouncement","parameters":[{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TariffAnnouncementRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:write","devices:tariffannouncement:write"]}],"summary":"Update tariff announcement setting for an existing device","tags":["devices"]}},"/groupfaxlines":{"get":{"description":"","operationId":"getGroupFaxlinesForUser","parameters":[{"description":"The unique user identifier","in":"query","name":"userId","required":false,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupFaxlinesResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}],"summary":"List all group fax lines","tags":["groups"]}},"/groupfaxlines/{faxlineId}/callerid":{"get":{"description":"","operationId":"getGroupFaxlineCallerId","parameters":[{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineCallerIdResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}],"summary":"Get the caller ID of a specific group fax","tags":["groups"]}},"/groupfaxlines/{faxlineId}/numbers":{"get":{"description":"","operationId":"getGroupFaxlineNumbers","parameters":[{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}],"summary":"List all phone numbers routed to group fax line","tags":["groups"]}},"/groups":{"get":{"description":"","operationId":"getGroups","parameters":[{"description":"The unique user identifier","in":"query","name":"userId","required":false,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SimpleGroupsResponse"}}},"security":[{"oauth2":["all","groups:read"]}],"summary":"List all groups","tags":["groups"]}},"/groups/{groupId}":{"get":{"description":"","operationId":"getGroup","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupResponse"}}},"security":[{"oauth2":["all","groups:read"]}],"summary":"Get a single groups details","tags":["groups"]}},"/groups/{groupId}/devices":{"post":{"description":"","operationId":"addDeviceToGroup","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RouteDeviceRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","groups:devices:write"]}],"summary":"Add device to group","tags":["groups"]}},"/groups/{groupId}/devices/{deviceId}":{"delete":{"description":"","operationId":"removeDeviceFromGroup","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"},{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","groups:devices:write"]}],"summary":"Remove device from group","tags":["groups"]}},"/groups/{groupId}/faxlines":{"get":{"description":"","operationId":"getGroupFaxlines","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupFaxlinesResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}],"summary":"List all fax lines for a specific group","tags":["groups"]}},"/groups/{groupId}/numbers":{"get":{"description":"","operationId":"getGroupNumbers","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupNumbersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:numbers:read"]}],"summary":"List all phone numbers routed to group","tags":["groups"]}},"/groups/{groupId}/users":{"get":{"description":"","operationId":"getGroupUsers","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupUsersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:users:read"]}],"summary":"List all group members","tags":["groups"]}},"/groups/{groupId}/voicemail":{"get":{"deprecated":true,"description":"","operationId":"getGroupVoicemail","parameters":[{"description":"The unique group identifier","in":"path","name":"groupId","required":true,"type":"string","x-example":"g0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineVoicemailsResponse"}}},"security":[{"oauth2":["all","groups:read","groups:voicemails:read"]}],"summary":"List all voicemails for a specific group","tags":["groups"]}},"/history":{"delete":{"description":"","operationId":"deleteHistoryEntries","parameters":[{"collectionFormat":"multi","description":"List of entry ids to delete","in":"query","items":{"type":"string"},"name":"id","required":false,"type":"array"}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Delete multiple calls, faxes, SMS or voicemails","tags":["history"]},"get":{"description":"","operationId":"getHistory","parameters":[{"collectionFormat":"multi","description":"List of extensions","in":"query","items":{"type":"string"},"name":"connectionIds","required":false,"type":"array"},{"collectionFormat":"multi","description":"Filter by type","in":"query","items":{"enum":["CALL","VOICEMAIL","SMS","FAX"],"type":"string"},"name":"types","required":false,"type":"array"},{"collectionFormat":"multi","description":"Filter for incoming/outgoing/missed","in":"query","items":{"enum":["INCOMING","OUTGOING","MISSED_INCOMING","MISSED_OUTGOING"],"type":"string"},"name":"directions","required":false,"type":"array"},{"default":0,"description":"The offset used for pagination","format":"int32","in":"query","maximum":2.147483647E9,"minimum":0.0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"Limit result rows","format":"int32","in":"query","maximum":1000.0,"minimum":0.0,"name":"limit","required":false,"type":"integer"},{"default":false,"description":"Only show archived events","in":"query","name":"archived","required":false,"type":"boolean"},{"collectionFormat":"multi","description":"Filter for starred/unstarred","in":"query","items":{"enum":["STARRED","UNSTARRED"],"type":"string"},"name":"starred","required":false,"type":"array"},{"description":"Filter 'from' date time in ISO8601 format","in":"query","name":"from","required":false,"type":"string"},{"description":"Filter 'to' date time in ISO8601 format","in":"query","name":"to","required":false,"type":"string"},{"description":"Filter events to or from given number","in":"query","name":"phonenumber","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryResponse"}}},"security":[{"oauth2":["all","history:read"]}],"summary":"List all calls, faxes, SMS and voicemails","tags":["history"]},"put":{"description":"","operationId":"updateHistoryEntries","parameters":[{"description":"A list of events which should be updated. Must be less than 150","in":"body","name":"body","required":false,"schema":{"items":{"$ref":"#/definitions/UpdateHistoryEntriesRequest"},"type":"array"}}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Update multiple calls, faxes, SMS or voicemails","tags":["history"]}},"/history/export":{"get":{"description":"","operationId":"getHistoryCSV","parameters":[{"collectionFormat":"multi","description":"List of extensions","in":"query","items":{"type":"string"},"name":"connectionIds","required":false,"type":"array"},{"collectionFormat":"multi","description":"Filter by type","in":"query","items":{"enum":["CALL","VOICEMAIL","SMS","FAX"],"type":"string"},"name":"types","required":false,"type":"array"},{"collectionFormat":"multi","description":"Filter for incoming/outgoing/missed","in":"query","items":{"enum":["INCOMING","OUTGOING","MISSED_INCOMING","MISSED_OUTGOING"],"type":"string"},"name":"directions","required":false,"type":"array"},{"default":0,"description":"The offset used for pagination","format":"int32","in":"query","maximum":2.147483647E9,"minimum":0.0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"Limit result rows","format":"int32","in":"query","maximum":1000.0,"minimum":0.0,"name":"limit","required":false,"type":"integer"},{"default":false,"description":"Only show archived events","in":"query","name":"archived","required":false,"type":"boolean"},{"collectionFormat":"multi","description":"Filter for starred/unstarred","in":"query","items":{"enum":["STARRED","UNSTARRED"],"type":"string"},"name":"starred","required":false,"type":"array"},{"description":"Filter 'from' date time in ISO8601 format","in":"query","name":"from","required":false,"type":"string"},{"description":"Filter 'to' date time in ISO8601 format","in":"query","name":"to","required":false,"type":"string"}],"produces":["application/octet-stream"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryResponse"}}},"security":[{"oauth2":["all","history:read"]}],"summary":"List all calls, faxes, SMS and voicemails as csv","tags":["history"]}},"/history/{entryId}":{"delete":{"description":"","operationId":"deleteHistoryEntry","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"abc123"}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Delete a call, fax, SMS or voicemail","tags":["history"]},"get":{"description":"","operationId":"getHistoryById","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"abc123"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryEntryResponse"}}},"security":[{"oauth2":["all","history:read"]}],"summary":"Get a specific call, fax, SMS or voicemail","tags":["history"]},"put":{"description":"","operationId":"updateHistoryEntry","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"abc123"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/UpdateHistoryEntryRequest"}}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Update a specific call, fax, SMS or voicemail","tags":["history"]}},"/history/{entryId}/archive":{"put":{"deprecated":true,"description":"","operationId":"setArchive","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"12345"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetHistoryEntryArchiveRequest"}}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Archive a specific entry.","tags":["history"]}},"/history/{entryId}/note":{"put":{"deprecated":true,"description":"","operationId":"setHistoryEntryNote","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"abc123"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetHistoryEntryNoteRequest"}}],"produces":["application/octet-stream","application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryEntryResponse"}}},"security":[{"oauth2":["all","history:write"]}],"summary":"Get a specific call, fax, SMS or voicemail","tags":["history"]}},"/history/{entryId}/read":{"put":{"deprecated":true,"description":"","operationId":"setReadProperty","parameters":[{"description":"The unique call, fax, sms or voicemail identifier","in":"path","name":"entryId","required":true,"type":"string","x-example":"12345"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetHistoryEntryReadRequest"}}],"produces":["application/octet-stream","application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}],"summary":"Mark an specific entry as read or unread","tags":["history"]}},"/log/webhooks":{"get":{"description":"","operationId":"getWebhooksLog","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineSipgateIoLogsResponse"}},"403":{"description":"Feature not booked"},"500":{"description":"Internal server error"}},"security":[{"oauth2":["all","log:webhooks:read"]}],"summary":"Get your webhooks log","tags":["log"]}},"/numbers":{"get":{"description":"Possible portState->status codes:<br /><pre>100: Waiting for user fax\n150: WBCI waiting for mail opt-in\n160: WBCI opt-in hash generated\n170: WBCI opt-in link clicked\n200: Waiting for fax from current network operator\n250: WBCI send\n251: WBCI network error\n252: WBCI EKP rejected\n400: Porting accepted\n450: Waiting for data exchange\n451: Data exchange error\n500: Porting complete\n600: Porting cancelled\n</pre>","operationId":"getNumbers","parameters":[{"format":"int32","in":"query","name":"offset","required":false,"type":"integer"},{"format":"int32","in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}],"summary":"List all phone numbers","tags":["numbers"]}},"/numbers/quickdial":{"post":{"description":"","operationId":"addQuickDialNumber","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddDirectDialRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}],"summary":"Add a new quick dial number","tags":["numbers"]}},"/numbers/quickdial/validation/{quickDialNumber}":{"get":{"description":"","operationId":"validateQuickDialNumber","parameters":[{"description":"The quick dial number","in":"path","name":"quickDialNumber","required":true,"type":"string","x-example":"42"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:read"]}],"summary":"Check if quick dial number is already taken","tags":["numbers"]}},"/numbers/quickdial/{numberId}":{"delete":{"description":"","operationId":"deleteQuickDialNumber","parameters":[{"description":"The unique quick dial number identifier","in":"path","name":"numberId","required":true,"type":"string","x-example":"abc123"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}],"summary":"Delete an existing quick dial number","tags":["numbers"]}},"/numbers/quickdial/{quickdialId}":{"put":{"description":"","operationId":"changeQuickDialNumber","parameters":[{"in":"path","name":"quickdialId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeDirectDialRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}],"summary":"Update an existing quick dial number","tags":["numbers"]}},"/numbers/{numberId}":{"put":{"description":"","operationId":"changeNumberSettings","parameters":[{"description":"The unique phone number identifier","in":"path","name":"numberId","required":true,"type":"string","x-example":"123"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeNumberSettingsRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Number not found"}},"security":[{"oauth2":["all","numbers:write"]}],"summary":"Change phone number settings, e.g. route to endpoint","tags":["numbers"]}},"/phonelines":{"get":{"description":"","operationId":"getAllPhonelines","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountPhonelinesResponse"}}},"security":[{"oauth2":["all","phonelines:read"]}],"summary":"List all phone lines of the account","tags":["phonelines"]}},"/portings":{"get":{"description":"Possible status codes:<br /><pre>100: Waiting for user fax\n150: WBCI waiting for mail opt-in\n160: WBCI opt-in hash generated\n170: WBCI opt-in link clicked\n200: Waiting for fax from current network operator\n250: WBCI send\n251: WBCI network error\n252: WBCI EKP rejected\n400: Porting accepted\n450: Waiting for data exchange\n451: Data exchange error\n500: Porting complete\n600: Porting cancelled\n</pre>","operationId":"getPortings","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortingsResponse"}}},"security":[{"oauth2":["all","portings:read"]}],"summary":"List all phone number portings","tags":["portings"]}},"/portings/{portingId}":{"delete":{"description":"","operationId":"revokePorting","parameters":[{"format":"int32","in":"path","name":"portingId","required":true,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortingsResponse"}}},"security":[{"oauth2":["all","portings:write"]}],"summary":"Delete/revoke an existing porting","tags":["portings"]},"get":{"description":"","operationId":"getPorting","parameters":[{"format":"int32","in":"path","name":"portingId","required":true,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortingResponse"}}},"security":[{"oauth2":["all","portings:read"]}],"summary":"Get an existing porting","tags":["portings"]}},"/restrictions":{"get":{"consumes":["application/json"],"description":"Get restrictions for actions the authenticated user can perform for himself or another user.","operationId":"getRestrictions","parameters":[{"description":"The unique user identifier","in":"query","name":"userId","required":true,"type":"string","x-example":"w0"},{"collectionFormat":"multi","description":"The requested restrictions","in":"query","items":{"enum":["CAN_CREATE_REGISTER_DEVICE","CAN_DELETE_REGISTER_DEVICE","CAN_CREATE_TRUNK_DEVICE","CAN_DELETE_TRUNK_DEVICE","CAN_BOOK_TRUNKING","CAN_SEE_TRUNKING_CONTINGENT_ADVERTISEMENT","CAN_CREATE_MOBILE_DEVICE","CAN_DELETE_MOBILE_DEVICE","CAN_CREATE_UNLINKED_MOBILE_DEVICE","CAN_DELETE_SIM_DEVICE","CAN_CREATE_EXTERNAL_DEVICE","CAN_DELETE_EXTERNAL_DEVICE","CAN_CHANGE_EXTERNAL_DEVICE","CAN_CREATE_PHONELINE_EXTENSION","CAN_DELETE_PHONELINE_EXTENSION","CAN_CREATE_QUICKDIAL_NUMBER","CAN_CHANGE_QUICKDIAL_NUMBER","CAN_DELETE_QUICKDIAL_NUMBER","CAN_CREATE_FAX_EXTENSION","CAN_DELETE_FAX_EXTENSION","CAN_SEND_FAX","CAN_RECEIVE_FAX","CAN_CHANGE_DEVICE_EMERGENCY_LOCATION","CAN_ACTIVATE_SIM","CAN_GET_ACCOUNT_BALANCE","CAN_USE_AUTOPROVISION","CAN_GET_BLACKLIST","CAN_MANAGE_BLACKLIST","CAN_CHANGE_PHONE_PROVISIONING_CONFIGURATION","CAN_GET_PHONE_PROVISIONING_CONFIGURATION","CAN_ACCOUNT_SEND_WEB_SMS","CAN_ACTIVATE_CALL_RECORDING","CAN_CHANGE_BUSY_ON_BUSY","CAN_CREATE_CRM_INTEGRATION","CAN_CHANGE_CRM_INTEGRATION","CAN_DELETE_CRM_INTEGRATION","CAN_GET_CONTRACTS","CAN_CHANGE_USER_LOCATION","CAN_CHANGE_USER_LOGIN","CAN_CHANGE_USER_ROLE","CAN_CHANGE_USER_NAME","CAN_USE_PBX_FEATURES","CAN_USE_TRUNKS","CAN_CHANGE_CONFERENCE_ROOMS","CAN_USE_CONFERENCE_ROOMS","CAN_CREATE_CONFERENCE_ROOM","CAN_USE_AFFILIATE","CAN_USE_PUSH_API","CAN_CREATE_SHARED_CONTACTS","CAN_USE_SOFTPHONE","CAN_USE_TEAM_CLINQ","CAN_ADD_PHONE_NUMBER","CAN_EDIT_GROUP_SETTINGS","CAN_INDIVIDUALIZE_ACCOUNT","CAN_CREATE_WEBUSER","CAN_CREATE_UNLINKED_DEVICE","CAN_DELETE_UNLINKED_DEVICE","CAN_SEE_PREVIEW_MESSAGES","CAN_CHANGE_FORWARDING_TIMES","CAN_USE_UNLINKED_DEVICES","CAN_USE_GROUPS","CAN_CREATE_GROUP","CAN_USE_WEB_BLF","CAN_CHANGE_VOICEMAIL_SETTINGS","CAN_CREATE_SHARED_VOIP_PHONE_WITHOUT_CHARGE","CAN_CREATE_EXTRA_VOIP_PHONE_WITHOUT_CHARGE","CAN_CREATE_GREETING_FOR_ALL_USERS","CAN_CREATE_CALL_QUEUE","CAN_USE_CALL_QUEUE","CAN_USE_IVR","CAN_CREATE_IVR","CAN_CHANGE_TRUNKS","CAN_USE_SIPGATE_APP","CAN_USE_ACD","CAN_EDIT_ACD_SETTINGS","CAN_CREATE_ADDRESS","CAN_DELETE_ADDRESS","CAN_EDIT_ADDRESS","CAN_MOVE_ADDRESS","CAN_USE_PHONEBOOK_ENTRY","CAN_EDIT_PHONEBOOK_ENTRY","CAN_USE_SAML_SSO","NOTIFICATION_RESTRICTIONS","GSUITE_EXTENSION"],"type":"string"},"name":"restriction","required":false,"type":"array","x-example":"CAN_CREATE_REGISTER_DEVICE"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RestrictionsResponse"}}},"security":[{"oauth2":["internal"]}],"summary":"List all restrictions based on the users product","tags":["restrictions"]}},"/sessions/calls":{"post":{"description":"DeviceId is only required if the caller parameter is a phone number and not a deviceId itself.<br>Use callerId to set a custom number that will be displayed to the callee.<br>This route only works for classic pbx accounts. Use the v2/calls route to initiate a call for neo pbx accounts.","operationId":"newCall","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewCallRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InitiateNewCallSessionResponse"}},"400":{"description":"User supplied invalid callee number<br>User supplied invalid caller number<br>DeviceId is required if caller is a phone number"},"402":{"description":"Insufficient funds"},"403":{"description":"User is not allowed to initiate call with given parameters"}},"security":[{"oauth2":["all","sessions:write","sessions:calls:write"]}],"summary":"Initiate a new call","tags":["sessions"]}},"/sessions/fax":{"post":{"description":"","operationId":"sendFax","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SendFaxRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendFaxSessionResponse"}},"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:fax:write"]}],"summary":"Send a fax","tags":["sessions"]}},"/sessions/fax/resend":{"post":{"description":"","operationId":"resendFax","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ResendFaxRequest"}}],"produces":["application/json"],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:fax:write"]}],"summary":"Resend a faX","tags":["sessions"]}},"/sessions/ivr/recording":{"post":{"description":"","operationId":"newIvrRecording","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewIvrRecordingRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InitiateNewCallSessionResponse"}},"400":{"description":"User supplied invalid callee number<br>User supplied invalid caller number<br>DeviceId is required if caller is a phone number"},"402":{"description":"Insufficient funds"},"403":{"description":"User is not allowed to initiate call with given parameters"}},"security":[{"oauth2":["all","sessions:write","sessions:calls:write"]}],"summary":"Initiate a new call to record an ivr message","tags":["sessions"]}},"/sessions/sms":{"post":{"description":"","operationId":"sendWebSms","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SendWebSmsRequest"}}],"produces":["application/json"],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:sms:write"]}],"summary":"Send a text message","tags":["sessions"]}},"/sessions/voicemail/play":{"post":{"description":"","operationId":"playRecording","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PlayRecordingRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InitiateNewCallSessionResponse"}},"400":{"description":"User supplied invalid callee number<br>User supplied invalid caller number<br>DeviceId is required if caller is a phone number"},"402":{"description":"Insufficient funds"},"403":{"description":"User is not allowed to initiate call with given parameters"}},"security":[{"oauth2":["all","sessions:write","sessions:calls:write"]}],"summary":"Initiate a new call to playback a voicemail","tags":["sessions"]}},"/sessions/voicemail/recording":{"post":{"description":"","operationId":"newRecording","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewVoicemailRecordingRecordingRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InitiateNewCallSessionResponse"}},"400":{"description":"User supplied invalid callee number<br>User supplied invalid caller number<br>DeviceId is required if caller is a phone number"},"402":{"description":"Insufficient funds"},"403":{"description":"User is not allowed to initiate call with given parameters"}},"security":[{"oauth2":["all","sessions:write","sessions:calls:write"]}],"summary":"Initiate a new call to record a greeting","tags":["sessions"]}},"/settings/sipgateio":{"get":{"description":"","operationId":"getSipgateIoUrls","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipgateIoUrlResponse"}},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","settings:read","settings:sipgateio:read"]}],"summary":"List sipgate.io global settings","tags":["settings"]},"put":{"description":"","operationId":"setSipgateIoUrls","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSipgateIoAccountSettingsRequest"}}],"produces":["application/json"],"responses":{"400":{"description":"unsupported pushApiVersion"},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","settings:write","settings:sipgateio:write"]}],"summary":"Update sipgate.io global settings","tags":["settings"]}},"/translations/{language}":{"get":{"description":"","operationId":"getLanguage","parameters":[{"description":"The language","in":"path","name":"language","required":true,"type":"string","x-example":"de_DE"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"summary":"List sipgate translations for a specific language","tags":["app"]}},"/users":{"get":{"description":"","operationId":"getAllUsers","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersResponse"}}},"security":[{"oauth2":["all","users:read"]}],"summary":"List all users","tags":["users"]}},"/users/{userId}":{"delete":{"description":"","operationId":"deleteUser","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserResponse"}},"404":{"description":"User not found"}},"security":[{"oauth2":["all","users:write"]}],"summary":"Delete a specific user","tags":["users"]},"get":{"description":"","operationId":"getUser","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserResponse"}},"404":{"description":"User not found"}},"security":[{"oauth2":["all","users:read"]}],"summary":"Get a specific user","tags":["users"]}},"/users/{userId}/busyonbusy":{"put":{"description":"","operationId":"setBusyOnBusySetting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetBusyOnBusySettingsRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","users:busyonbusy:write"]}],"summary":"Update the busy on busy setting for a user","tags":["users"]}},"/users/{userId}/defaultdevice":{"put":{"description":"","operationId":"setDefaultDevice","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetDefaultDeviceRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","users:read","users:defaultdevice:write"]}],"summary":"Update default device for an existing user","tags":["users"]}},"/users/{userId}/location":{"put":{"description":"","operationId":"setLocation","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetLocationRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","users:write"]}],"summary":"Set location for user","tags":["users"]}},"/voicemails":{"get":{"description":"","operationId":"getVoicemails","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsResponse"}}},"security":[{"oauth2":["all","voicemails:read"]}],"summary":"List all voicemails","tags":["voicemails"]}},"/voicemails/{voicemailId}":{"get":{"description":"","operationId":"getVoicemail","parameters":[{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailResponse"}}},"security":[{"oauth2":["all","voicemails:read"]}],"summary":"Get a single voicemail","tags":["voicemails"]}},"/{userId}/callrestrictions/{restriction}":{"post":{"description":"","operationId":"setCallRestriction","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The name of the call restriction","in":"path","name":"restriction","required":true,"type":"string","x-example":"roaming"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetCallRestrictionRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallRestrictionResponse"}},"404":{"description":"Call restriction not found"}},"security":[{"oauth2":["all","callrestrictions:write"]}],"summary":"Enable/disable restriction","tags":["callrestrictions"]}},"/{userId}/devices":{"get":{"description":"","operationId":"getDevices","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"Comma-separated list of device types to filter. Allowed values: all, app, register, mobile, external","in":"query","name":"type","required":false,"type":"string","x-example":"register,mobile,external"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevicesResponse"}}},"security":[{"oauth2":["all","devices:read"]}],"summary":"List all devices","tags":["devices"]},"post":{"description":"If you want to create a new register device the Restriction CAN_CREATE_REGISTER_DEVICE needs to be true for the specified userId.","operationId":"createDevice","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateDeviceRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Create a new device","tags":["devices"]}},"/{userId}/devices/external":{"post":{"description":"If you want to create a new external device the Restriction CAN_CREATE_EXTERNAL_DEVICE needs to be true for the specified userId.","operationId":"createExternalDevice","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateExternalDeviceRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Create a new external device","tags":["devices"]}},"/{userId}/devices/mobile":{"post":{"description":"If you want to create a new mobile device the Restriction CAN_CREATE_MOBILE_DEVICE needs to be true for the specified userId.","operationId":"createMobileDevice","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateMobileDeviceRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MobileDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Create a new mobile device","tags":["devices"]}},"/{userId}/devices/register":{"post":{"description":"If you want to create a new register device the Restriction CAN_CREATE_REGISTER_DEVICE needs to be true for the specified userId.","operationId":"createRegisterDevice","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateRegisterDeviceRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RegisterDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}],"summary":"Create a new register device","tags":["devices"]}},"/{userId}/devices/{deviceId}/contingents":{"get":{"description":"","operationId":"getDeviceContingents","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"y0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceContingentsResponse"}}},"security":[{"oauth2":["all","devices:read"]}],"summary":"List all device contingents","tags":["devices"]}},"/{userId}/devices/{deviceId}/sim":{"delete":{"description":"","operationId":"deactivateSim","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique mobile device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"y0"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:sim:write"]}],"summary":"Deactivate the SIM card for a specific device","tags":["devices"]},"post":{"description":"","operationId":"activateSim","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique mobile device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"y0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActivateSimRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:sim:write"]}],"summary":"Activate a SIM card for a specific device","tags":["devices"]}},"/{userId}/devices/{deviceId}/sim/orders":{"post":{"description":"","operationId":"orderSim","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique mobile device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"y0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrderSimRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"User or device not found"}},"security":[{"oauth2":["all","devices:write","devices:sim:write","devices:sims:orders:write"]}],"summary":"Order a new SIM card for a specific device","tags":["devices"]}},"/{userId}/faxlines":{"get":{"description":"","operationId":"getUserFaxlines","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlinesResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:read"]}],"summary":"List all fax lines","tags":["faxlines"]},"post":{"description":"","operationId":"createFaxline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineResponse"}}},"security":[{"oauth2":["all","faxlines:write"]}],"summary":"Create a new fax line","tags":["faxlines"]}},"/{userId}/faxlines/{faxlineId}":{"delete":{"description":"","operationId":"deleteFaxline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","faxlines:write"]}],"summary":"Delete an existing fax line","tags":["faxlines"]},"put":{"description":"","operationId":"changeFaxlineAlias","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Faxline not found"}},"security":[{"oauth2":["all","faxlines:write"]}],"summary":"Update alias for an existing fax line","tags":["faxlines"]}},"/{userId}/faxlines/{faxlineId}/callerid":{"get":{"description":"","operationId":"getFaxlineCallerId","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineCallerIdResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:read"]}],"summary":"Get the caller ID of a specific fax line","tags":["faxlines"]},"put":{"description":"","operationId":"changeFaxlineCallerIdSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxlineCallerIdRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:write"]}],"summary":"Update the caller ID for an existing fax line","tags":["faxlines"]}},"/{userId}/faxlines/{faxlineId}/numbers":{"get":{"description":"","operationId":"getFaxlineNumbers","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","faxlines:read","faxlines:numbers:read"]}],"summary":"List all phone numbers routed to fax line","tags":["faxlines"]}},"/{userId}/faxlines/{faxlineId}/tagline":{"put":{"description":"","operationId":"changeTagline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique fax line identifier","in":"path","name":"faxlineId","required":true,"type":"string","x-example":"f0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxlineTaglineRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:write"]}],"summary":"Update tagline of an existing fax line","tags":["faxlines"]}},"/{userId}/notifications":{"get":{"description":"","operationId":"getNotifications","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}}},"security":[{"oauth2":["all","notifications:read"]}],"summary":"Get all notifications","tags":["notifications"]}},"/{userId}/notifications/call/email":{"post":{"description":"","operationId":"createEmailNotificationForCall","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddCallEmailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Limit reached"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new email notification for calls","tags":["notifications"]}},"/{userId}/notifications/call/sms":{"post":{"description":"","operationId":"createSmsNotificationForCall","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddCallSmsNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Limit reached"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new sms notification for calls","tags":["notifications"]}},"/{userId}/notifications/fax/email":{"post":{"description":"","operationId":"addFaxEmailNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxEmailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new email notification for faxes","tags":["notifications"]}},"/{userId}/notifications/fax/report":{"post":{"description":"","operationId":"addFaxReportEmailNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxReportEmailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new email notification for fax reports","tags":["notifications"]}},"/{userId}/notifications/fax/sms":{"post":{"description":"","operationId":"addFaxSmsNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxSmsNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new sms notification for faxes","tags":["notifications"]}},"/{userId}/notifications/sms/email":{"post":{"description":"","operationId":"addSmsEmailNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddSmsEmailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"SMSToMail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new email notification for incoming sms","tags":["notifications"]}},"/{userId}/notifications/voicemail/email":{"post":{"description":"","operationId":"addVoicemailEmailNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddVoicemailEmailVoicemailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new email notification for voicemails","tags":["notifications"]}},"/{userId}/notifications/voicemail/sms":{"post":{"description":"","operationId":"addVoicemailSmsNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddVoicemailSmslVoicemailNotificationRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Create a new sms notification for voicemails","tags":["notifications"]}},"/{userId}/notifications/{notificationId}":{"delete":{"description":"","operationId":"deleteNotification","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique notification identifier","in":"path","name":"notificationId","required":true,"type":"string","x-example":"abc123"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","notifications:write"]}],"summary":"Delete an existing notification","tags":["notifications"]}},"/{userId}/numbers":{"get":{"description":"Possible portState->status codes:<br /><pre>100: Waiting for user fax\n150: WBCI waiting for mail opt-in\n160: WBCI opt-in hash generated\n170: WBCI opt-in link clicked\n200: Waiting for fax from current network operator\n250: WBCI send\n251: WBCI network error\n252: WBCI EKP rejected\n400: Porting accepted\n450: Waiting for data exchange\n451: Data exchange error\n500: Porting complete\n600: Porting cancelled\n</pre>","operationId":"getUserNumbers","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}],"summary":"List all user phone numbers of a specific user","tags":["numbers"]}},"/{userId}/phonelines":{"get":{"description":"","operationId":"getPhonelines","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SimplePhonelinesResponse"}}},"security":[{"oauth2":["all","phonelines:read"]}],"summary":"List all phone lines","tags":["phonelines"]},"post":{"description":"","operationId":"createPhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SimplePhonelineResponse"}}},"security":[{"oauth2":["all","phonelines:write"]}],"summary":"Create a new phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}":{"delete":{"description":"","operationId":"deletePhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"404":{"description":"Phoneline not found"}},"security":[{"oauth2":["all","phonelines:write"]}],"summary":"Delete an existing phone line","tags":["phonelines"]},"get":{"description":"","operationId":"getPhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineResponse"}}},"security":[{"oauth2":["all","phonelines:read"]}],"summary":"Get a single phoneline","tags":["phonelines"]},"put":{"description":"","operationId":"setPhonelineAlias","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Phoneline not found"}},"security":[{"oauth2":["all","phonelines:write"]}],"summary":"Update alias for an existing phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/blockanonymous":{"get":{"description":"","operationId":"getBlockAnonymousSetting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineBlockAnonymousResponse"}}},"security":[{"oauth2":["all","phonelines:blockanonymous:read"]}],"summary":"Get the block anonymous setting of a specific phone line","tags":["phonelines"]},"put":{"description":"","operationId":"setBlockAnonymousSetting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetBlockAnonymousSettingsRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineBlockAnonymousResponse"}}},"security":[{"oauth2":["all","phonelines:blockanonymous:write"]}],"summary":"Update the block anonymous setting for an existing phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/devices":{"get":{"description":"","operationId":"getDevicesForPhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevicesResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:devices:read"]}],"summary":"List all devices of a specific phone line","tags":["phonelines"]},"post":{"description":"","operationId":"addDeviceToPhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RouteDeviceRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:devices:write"]}],"summary":"Add device to phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/devices/{deviceId}":{"delete":{"description":"","operationId":"removeDeviceFromPhoneline","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique device identifier","in":"path","name":"deviceId","required":true,"type":"string","x-example":"e0"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:devices:write"]}],"summary":"Remove device from phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/forwardings":{"get":{"operationId":"getPhonelineForwardings_1","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LegacyForwardingResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:forwardings:read"]}],"summary":"List all forwarding settings of a specific phone line","tags":["forwardings"]},"put":{"consumes":["application/json"],"operationId":"setPhonelineForwardingSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/LegacyForwardingRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LegacyForwardingSetResponse"}},"400":{"description":"Forwarding settings could not be changed due to bad request"},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","phonelines:write","phonelines:forwardings:write"]}],"summary":"Update forwarding settings for an existing phone line","tags":["forwardings"]}},"/{userId}/phonelines/{phonelineId}/numbers":{"get":{"description":"","operationId":"getPhonelineNumbers","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:numbers:read"]}],"summary":"List all phone numbers routed to phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/parallelforwardings":{"get":{"deprecated":true,"description":"","operationId":"getPhonelineParallelForwardings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParallelForwardingsResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:parallelforwardings:read"]}],"summary":"List all parallel forwardings of a specific phone line","tags":["phonelines"]},"post":{"deprecated":true,"description":"","operationId":"addParallelForwarding","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetParallelForwardingRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"summary":"Create parallel forwarding for an existing phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/parallelforwardings/{parallelForwardingId}":{"delete":{"deprecated":true,"description":"","operationId":"deleteParallelForwardingSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique external device identifier","in":"path","name":"parallelForwardingId","required":true,"type":"string","x-example":"x0"}],"produces":["application/json"],"responses":{"404":{"description":"Parallel forwarding not found"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"summary":"Delete parallel forwarding","tags":["phonelines"]},"put":{"deprecated":true,"description":"","operationId":"changeParallelForwardingSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique external device identifier","in":"path","name":"parallelForwardingId","required":true,"type":"string","x-example":"x0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetParallelForwardingRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Parallel forwarding not found"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"summary":"Update an existing parallel forwarding","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/sipgateio":{"get":{"description":"","operationId":"getSipgateIoSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineSipgateIoResponse"}},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:sipgateio:read"]}],"summary":"List sipgate.io settings of a specific phone line","tags":["phonelines"]},"put":{"description":"","operationId":"setSipgateIoSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSipgateIoPhonelineSettingsRequest"}}],"produces":["application/json"],"responses":{"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","phonelines:write","phonelines:sipgateio:write"]}],"summary":"Update sipgate.io settings for an existing phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/sipgateio/log":{"get":{"description":"","operationId":"getSipgateIoLogs","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineSipgateIoLogsResponse"}},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:sipgateio:log:read"]}],"summary":"List sipgate.io debug log for a specific phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/voicemails":{"get":{"deprecated":true,"description":"","operationId":"getVoicemails","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineVoicemailsResponse"}},"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:voicemails:read"]}],"summary":"List all voicemails of a specific phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}":{"put":{"description":"","operationId":"changeVoicemailSettings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeVoicemailRequest"}}],"produces":["application/json"],"responses":{"400":{"description":"Voicemail settings could not be changed due to bad request"},"403":{"description":"Transcription not available"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write"]}],"summary":"Update voicemail settings for a specific phone line","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}/greetings":{"get":{"description":"","operationId":"getPhonelineVoicemailGreetings","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingsResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:voicemails:read","phonelines:voicemails:greetings:read"]}],"summary":"List all greetings for a specific phone line voicemail","tags":["phonelines"]},"post":{"description":"","operationId":"addGreeting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddGreetingRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingsResponse"}}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}],"summary":"Create a new greeting for a specific phone line voicemail","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}/greetings/{greetingId}":{"delete":{"description":"","operationId":"deletePhonlineVoicemailGreeting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"},{"description":"The unique greeting identifier","in":"path","name":"greetingId","required":true,"type":"string","x-example":"abc123"}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}],"summary":"Delete an existing phone line voicemail greeting","tags":["phonelines"]},"put":{"description":"","operationId":"changePhonelineVoicemailGreeting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"},{"description":"The unique greeting identifier","in":"path","name":"greetingId","required":true,"type":"string","x-example":"abc123"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeVoicemailGreetingRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}],"summary":"Update an existing phone line voicemail greeting","tags":["phonelines"]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}/transcriptions":{"put":{"description":"","operationId":"changePhonelineVoicemailTranscriptionSetting","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique phone line identifier","in":"path","name":"phonelineId","required":true,"type":"string","x-example":"p0"},{"description":"The unique voicemail identifier","in":"path","name":"voicemailId","required":true,"type":"string","x-example":"v0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeVoicemailTranscriptionRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write"]}],"summary":"Update an existing phone line voicemail transcription setting","tags":["phonelines"]}},"/{userId}/sms":{"get":{"description":"","operationId":"getSmsExtensions","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsExtensionsResponse"}}},"security":[{"oauth2":["all","sms:read"]}],"summary":"List all short message services","tags":["sms"]}},"/{userId}/sms/{smsId}":{"put":{"description":"","operationId":"setSmsAlias","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"produces":["application/json"],"responses":{"404":{"description":"Short message service not found"}},"security":[{"oauth2":["all","sms:write"]}],"summary":"Update alias for an existing short message service","tags":["sms"]}},"/{userId}/sms/{smsId}/callerids":{"get":{"description":"","operationId":"getSmsCallerIds","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"}],"produces":["application/json"],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsCallerIdsResponse"}}},"security":[{"oauth2":["all","sms:read","sms:callerid:read"]}],"summary":"List all caller IDs for a specific short message service","tags":["sms"]},"post":{"description":"","operationId":"addCallerId","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SmsCallerIdRequest"}}],"produces":["application/json"],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}],"summary":"Create a new caller ID for an existing short message service","tags":["sms"]}},"/{userId}/sms/{smsId}/callerids/{callerId}":{"delete":{"description":"","operationId":"deleteSmsCallerId","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"},{"description":"The caller ID","format":"int32","in":"path","name":"callerId","required":true,"type":"integer","x-example":123}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}],"summary":"Delete an existing caller ID for a specific short message service","tags":["sms"]},"put":{"description":"","operationId":"editCallerId","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"},{"description":"The caller ID","format":"int32","in":"path","name":"callerId","required":true,"type":"integer","x-example":123},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSmsCallerIdRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}],"summary":"Update the caller ID for an existing short message service","tags":["sms"]}},"/{userId}/sms/{smsId}/callerids/{callerId}/verification":{"post":{"description":"","operationId":"verifyCallerId","parameters":[{"description":"The unique user identifier","in":"path","name":"userId","required":true,"type":"string","x-example":"w0"},{"description":"The unique short message service identifier","in":"path","name":"smsId","required":true,"type":"string","x-example":"s0"},{"description":"The caller ID","format":"int32","in":"path","name":"callerId","required":true,"type":"integer","x-example":123},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/VerifySmsCallerIdRequest"}}],"produces":["application/json"],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}],"summary":"Verify an existing caller ID for a specific short message service","tags":["sms"]}}},"schemes":["https"],"securityDefinitions":{"oauth2":{"authorizationUrl":"https://login.sipgate.com/auth/realms/third-party/protocol/openid-connect/auth","flow":"implicit","scopes":{"account:read":"Access account details","account:write":"Manage account details","acds:read":"Access ACDs","acds:statistics:read":"Access ACD statistics","acds:statistics:write":"Manage ACD statistics","acds:write":"Manage ACDs","addresses:read":"Access addresses","addresses:write":"Manage addresses","appbookings:read":"Access bookings of sipgate App","appbookings:write":"Manage bookings of sipgate App","audiofiles:read":"Access audio files","audiofiles:write":"Manage audio files","authorization:oauth2:clients:read":"Access OAuth 2.0 clients","authorization:oauth2:clients:write":"Manage OAuth 2.0 clients","authorization:oauth:clients:read":"Access OAuth clients","authorization:oauth:clients:write":"Manage OAuth clients","autorecording:greeting:read":"Access autorecording greeting","autorecording:greeting:write":"Manage autorecording greeting","balance:read":"Access account balance","blacklist:read":"Access blacklist","blacklist:write":"Manage blacklist","callrestrictions:read":"Access call restrictions","callrestrictions:write":"Manage call restrictions","channel:logins:read":"Read channel logins","channel:logins:write":"Manage channel logins","channels:events:read":"Access channels events","channels:events:recordings:read":"Access channel event recordings","channels:events:recordings:write":"Manage channel event recordings","channels:events:write":"Manage channels events","channels:read":"Access channels","channels:write":"Manage channels","conferencerooms:read":"Access conferencerooms","conferencerooms:write":"Manage conferencerooms","contacts:read":"Access contacts","contacts:write":"Manage contacts","contracts:crm:read":"Access your CRM contracts","contracts:read":"Access contracts","contracts:write":"Manage contracts","cx:management:read":"Access CX user and channel settings","cx:management:write":"Manage CX users and channels","cx:statistics:read":"Access CX statistics","cx:statistics:write":"Manage CX statistics","devices:callerid:read":"Access caller ID","devices:callerid:write":"Manage caller ID","devices:contingents:read":"Access mobile device contingents","devices:contingents:write":"Book, cancel, and revoke cancellations for mobile device contingents","devices:forwardings:read":"Access forwardings of a device","devices:forwardings:write":"Manage forwardings of a device","devices:localprefix:read":"Access automatic local area code","devices:localprefix:write":"Manage automatic local area code","devices:read":"Access device settings","devices:sim:read":"Access SIM settings","devices:sim:write":"Manage SIM settings","devices:sims:orders:write":"Order SIM cards for device","devices:singlerowdisplay:read":"Access hide own number settings","devices:singlerowdisplay:write":"Manage hide own number settings","devices:tariffannouncement:read":"Access rate announcement settings","devices:tariffannouncement:write":"Manage rate announcement settings","devices:write":"Manage device settings","events:read":"Access call events","events:write":"Manage call events","faxlines:numbers:read":"Access fax device settings (numbers)","faxlines:read":"Access fax device settings","faxlines:write":"Manage fax device settings","frontdesk:read":"Access Frontdesk settings","frontdesk:statistics:read":"Access Frontdesk statistics","frontdesk:statistics:write":"Manage Frontdesk statistics","frontdesk:write":"Manage Frontdesk settings","greetings:read":"Access greetings","greetings:write":"Manage greetings","groups:devices:write":"Manage group device settings","groups:faxlines:read":"Access group fax device settings","groups:forwardings:read":"Access forwardings of a group","groups:forwardings:write":"Manage forwardings of a group","groups:numbers:read":"Access group numbers","groups:read":"Access groups","groups:users:read":"Access group members","groups:voicemails:read":"Access group voicemail settings","groups:write":"Manage groups","history:read":"Access call history","history:write":"Manage call history","ivrs:read":"Access IVRs","ivrs:write":"Manage IVRs","labels:read":"Access user labels","labels:write":"Manage user labels","log:webhooks:read":"Read your webhooks log data","microsoftteams:fqdn:read":"Read your microsoft teams fqdn data","microsoftteams:fqdn:write":"Manage your microsoft teams fqdn data","notifications:read":"Access notifications","notifications:write":"Manage notifications","numbers:read":"Access phone numbers","numbers:write":"Manage phone numbers","openid":"User information","payment:methods:read":"Access payment methods","payment:methods:write":"Manage payment methods","phonelines:blockanonymous:read":"Access anonymous call settings","phonelines:blockanonymous:write":"Manage anonymous call settings","phonelines:busyonbusy:read":"Access busy on busy settings","phonelines:busyonbusy:write":"Manage busy on busy settings","phonelines:devices:read":"Access connection devices","phonelines:devices:write":"Manage connection devices","phonelines:forwardings:read":"Access call forwarding settings","phonelines:forwardings:write":"Manage call forwarding settings","phonelines:numbers:read":"Access connection numbers","phonelines:parallelforwardings:read":"Access parallel forwarding settings","phonelines:parallelforwardings:write":"Manage parallel forwarding settings","phonelines:read":"Access connections","phonelines:sipgateio:log:read":"Access webhook debug log","phonelines:sipgateio:read":"Access webhooks","phonelines:sipgateio:write":"Manage webhooks","phonelines:voicemails:greetings:read":"Access connection voicemail announcement settings","phonelines:voicemails:greetings:write":"Manage connection voicemail announcement settings","phonelines:voicemails:read":"Access connection voicemail settings","phonelines:voicemails:write":"Manage connection voicemail settings","phonelines:write":"Manage connections","phones:read":"Access provisioned phones","phones:write":"Manage provisioned phones","portings:read":"Access number ports","portings:write":"Manage number ports","products:read":"Access products","push_device:register":"Manage push notifications","rtcm:read":"Access active calls","rtcm:write":"Manage active calls","sessions:calls:write":"Initiate calls","sessions:fax:write":"Send faxes","sessions:sms:write":"Send SMS","sessions:write":"Initiate calls, send faxes, send SMS","settings:read":"Access global account settings","settings:sipgateio:read":"Access global webhooks","settings:sipgateio:write":"Manage global webhooks","settings:write":"Manage global account settings","simcards:order:write":"Order SIM cards for account","sms:callerid:read":"Access SMS caller ID","sms:callerid:write":"Manage SMS caller ID","sms:read":"Access SMS device settings","sms:write":"Manage SMS device settings","tacs:read":"List TACs and their texts","trunk:read":"Access Trunking settings","trunks:write":"Manage Trunking settings","user:notification:read":"Access user notification settings","user:notification:write":"Manage user notification settings","users:busyonbusy:write":"Manage busy on busy settings","users:defaultdevice:write":"Manage default device settings","users:presence:dnd:write":"Manage users' Do Not Disturb settings","users:read":"Access users","users:role:write":"Manage user roles","users:write":"Manage users","voicemails:read":"Access voicemails","voicemails:write":"Manage voicemails"},"tokenUrl":"https://api.sipgate.com/login/third-party/protocol/openid-connect/token","type":"oauth2"}},"swagger":"2.0","tags":[{"name":"account"},{"name":"addresses"},{"name":"app"},{"name":"authorization"},{"name":"blacklist"},{"name":"callrestrictions"},{"name":"contacts"},{"name":"devices"},{"name":"faxlines"},{"name":"groups"},{"name":"history"},{"name":"log"},{"name":"notifications"},{"name":"numbers"},{"name":"phonelines"},{"name":"portings"},{"name":"restrictions"},{"name":"rtcm"},{"name":"sessions"},{"name":"settings"},{"name":"sms"},{"name":"urls"},{"name":"users"},{"name":"voicemails"}]}