swagger.json

{"host":"api.sipgate.com","basePath":"/v2","swagger":"2.0","info":{"description":"This is the sipgate REST API documentation. We build our new applications on this API and we invite you to use it too.","title":"sipgate API","version":"2.0.0"},"schemes":["https"],"paths":{"/identityVerification":{"get":{"tags":["identityVerification"],"summary":"","description":"","operationId":"getVerification","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityVerificationResponse"}}},"security":[{"oauth2":["internal"]}]}},"/":{"get":{"tags":["urls"],"summary":"Get all toplevel API URLs","description":"","operationId":"getUrls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUrlsResponse"}}}}},"/account":{"get":{"tags":["account"],"summary":"Returns account data","description":"","operationId":"getAccount","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AccountResponse"}},"404":{"description":"Account not found"}},"security":[{"oauth2":["all","account:read"]}]}},"/account/verified":{"put":{"tags":["account"],"summary":"Verify your account","description":"","operationId":"verify","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AccountVerificationRequest"}}],"responses":{"404":{"description":"Verification code not found"}},"security":[{"oauth2":["all","account:write"]}]}},"/addresses":{"get":{"tags":["addresses"],"summary":"Returns all addresses with their corresponding addressIds","description":"","operationId":"getAddresses","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AddressesResponse"}}},"security":[{"oauth2":["all","addresses:read"]}]}},"/addresses/{addressId}":{"get":{"tags":["addresses"],"summary":"Returns address with their corresponding addressId","description":"","operationId":"getAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"e.g. 12345","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AddressResponse"}}},"security":[{"oauth2":["all","addresses:read"]}]},"put":{"tags":["addresses"],"summary":"Modify an address to change your location","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","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"e.g. 12345","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ModifyAddressRequest"}}],"responses":{"400":{"description":"Bad request"}},"security":[{"oauth2":["all","addresses:write"]}]}},"/addresses/{addressId}/numbers":{"get":{"tags":["addresses"],"summary":"Get all associated numbers for a given address","description":"","operationId":"getNumbers","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"e.g. 12345","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}]}},"/app/events":{"get":{"tags":["app"],"summary":"Get the active events for this account","description":"","operationId":"getEvents","parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventsResponse"}}},"security":[{"oauth2":["internal"]}]}},"/app/events/{id}":{"delete":{"tags":["app"],"summary":"Deletes an event by ID","description":"","operationId":"deleteEvent","parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"default":{"description":"successful operation"}}}},"/app/links":{"get":{"tags":["app"],"summary":"Returns external URLs for app.sipgate.com","description":"","operationId":"getLinks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LinksResponse"}}}}},"/app/properties":{"get":{"tags":["app"],"summary":"Returns properties for app.sipgate.com.","description":"","operationId":"getProperties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PropertiesResponse"}}},"security":[{"oauth2":["internal"]}]}},"/app/properties/welcome":{"put":{"tags":["app"],"summary":"Enable/Disable welcome screen","description":"","operationId":"changeWelcomeScreen","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WelcomeRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["internal"]}]}},"/app/tacs":{"get":{"tags":["app"],"summary":"Returns true if terms and conditions for app.sipgate.com have been accepted","description":"","operationId":"getTac","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TacResponse"}}},"security":[{"oauth2":["internal"]}]},"put":{"tags":["app"],"summary":"Accept/Revoke terms and conditions for app.sipgate.com","description":"","operationId":"acceptTac","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TacRequest"}}],"responses":{"default":{"description":"successful operation"}}}},"/authorization/token":{"post":{"tags":["authorization"],"summary":"Create a session token","description":"Use this session token in the <strong>Authorization</strong> header to access protected routes.<br><strong>Example header:</strong><br><pre>Authorization: Bearer &lt;token&gt;</pre>","operationId":"create","parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSessionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenCreateResponse"}},"401":{"description":"Invalid credentials supplied"}}},"delete":{"tags":["authorization"],"summary":"Invalidate a session token","description":"","operationId":"destroy","parameters":[{"name":"Authorization","in":"header","description":"token","required":false,"type":"string"}],"responses":{"401":{"description":"Invalid token supplied"}}}},"/authorization/userinfo":{"get":{"tags":["authorization"],"summary":"Returns information about the logged in user","description":"","operationId":"userinfo","parameters":[{"name":"Authorization","in":"header","description":"token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserinfoResponse"}},"401":{"description":"Invalid token supplied"}}}},"/balance":{"get":{"tags":["balance"],"summary":"Get the account balance","description":"","operationId":"getBalance","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BalanceResponse"}}},"security":[{"oauth2":["all","balance:read"]}]}},"/contacts/internal":{"get":{"tags":["internal contacts"],"summary":"Returns all contacts","description":"","operationId":"getAllContacts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InternalContactsResponse"}}},"security":[{"oauth2":["all","contacts:read"]}]}},"/devices/{deviceId}":{"get":{"tags":["devices"],"summary":"Returns a given devices","description":"","operationId":"getDevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceResponse"}}},"security":[{"oauth2":["all","devices:read"]}]},"put":{"tags":["devices"],"summary":"Change device settings","description":"","operationId":"changeDeviceSettings","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeDeviceRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}]},"delete":{"tags":["devices"],"summary":"Deletes a given device","description":"","operationId":"deleteDevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}]}},"/devices/{deviceId}/alias":{"put":{"tags":["devices"],"summary":"Change device alias","description":"","operationId":"changeDeviceAlias","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetDeviceAliasRequest"}}],"responses":{"403":{"description":"Device not found"}},"security":[{"oauth2":["all","devices:write"]}]}},"/devices/{deviceId}/callerid":{"get":{"tags":["devices"],"summary":"Caller ID for given device","description":"","operationId":"getCallerId","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallerIdResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:read","devices:callerid:read"]}]},"put":{"tags":["devices"],"summary":"Change caller ID for device","description":"","operationId":"changeCallerIdSettings","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CallerIdRequest"}}],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:write","devices:callerid:write"]}]}},"/devices/{deviceId}/credentials/password":{"post":{"tags":["devices"],"summary":"Change device password","description":"","operationId":"changeDevicePassword","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}]}},"/devices/{deviceId}/external/incomingcalldisplay":{"put":{"tags":["devices"],"summary":"Change the caller display of an external device.","description":"","operationId":"changeCallerDisplayOfDevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. x0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeExternalDeviceIncomingCallDisplayRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}]}},"/devices/{deviceId}/external/targetnumber":{"put":{"tags":["devices"],"summary":"Change the target number of an external device.","description":"","operationId":"changeTargetNumberOfDevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. x0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeExternalDeviceTargetNumberRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write"]}]}},"/devices/{deviceId}/localprefix":{"get":{"tags":["devices"],"summary":"Localprefix for given device","description":"","operationId":"getLocalprefix","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalprefixResponse"}}},"security":[{"oauth2":["all","devices:read","devices:localprefix:read"]}]},"put":{"tags":["devices"],"summary":"Change localprefix for device","description":"","operationId":"changeLocalprefixSettings","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/LocalprefixRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:localprefix:write"]}]}},"/devices/{deviceId}/singlerowdisplay":{"get":{"tags":["devices"],"summary":"Returns whether single row display setting is enabled or disabled for the given device","description":"","operationId":"getSingleRowDisplay","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SingleRowDisplayResponse"}}},"security":[{"oauth2":["all","devices:read","devices:singlerowdisplay:read"]}]},"put":{"tags":["devices"],"summary":"Enable/Disable single row display setting for the given device","description":"","operationId":"changeSingleRowDisplay","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SingleRowDisplayRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:singlerowdisplay:write"]}]}},"/devices/{deviceId}/tariffannouncement":{"get":{"tags":["devices"],"summary":"Returns whether tariff announcement is enabled or disabled for the given device","description":"","operationId":"getTariffAnnouncement","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TariffAnnouncementResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:read","devices:tariffannouncement:read"]}]},"put":{"tags":["devices"],"summary":"Enable/Disable tariff announcement for the given device","description":"","operationId":"changeTariffAnnouncement","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TariffAnnouncementRequest"}}],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","devices:write","devices:tariffannouncement:write"]}]}},"/groupfaxlines":{"get":{"tags":["groupfaxlines"],"summary":"Returns all group fax lines","description":"","operationId":"getFaxlines","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"e.g. w0","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlinesResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}]}},"/groupfaxlines/{faxlineId}/callerid":{"get":{"tags":["groupfaxlines"],"summary":"Returns the caller ID for a group fax","description":"","operationId":"getGroupFaxlineCallerId","produces":["application/json"],"parameters":[{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineCallerIdResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}]}},"/groupfaxlines/{faxlineId}/numbers":{"get":{"tags":["groupfaxlines"],"summary":"Returns all phone numbers for a group fax","description":"","operationId":"getGroupFaxlineNumbers","produces":["application/json"],"parameters":[{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}]}},"/groups":{"get":{"tags":["groups"],"summary":"Returns all groups","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"e.g. w0","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsResponse"}}},"security":[{"oauth2":["all","groups:read"]}]}},"/groups/{groupId}/devices":{"post":{"tags":["groups"],"summary":"Set routing for device to group","description":"","operationId":"routeDevices","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RouteDeviceRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","groups:devices:write"]}]}},"/groups/{groupId}/devices/{deviceId}":{"delete":{"tags":["groups"],"summary":"delete routing for device to group","description":"","operationId":"deleteDeviceRouting","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","groups:devices:write"]}]}},"/groups/{groupId}/faxlines":{"get":{"tags":["groups"],"summary":"Returns all group fax lines","description":"","operationId":"getFaxlines","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlinesResponse"}}},"security":[{"oauth2":["all","groups:read","groups:faxlines:read"]}]}},"/groups/{groupId}/numbers":{"get":{"tags":["groups"],"summary":"Returns all numbers routed to group","description":"","operationId":"getGroupNumbers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupNumbersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:numbers:read"]}]}},"/groups/{groupId}/users":{"get":{"tags":["groups"],"summary":"Returns all users in group","description":"","operationId":"getGroupUsers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupUsersResponse"}}},"security":[{"oauth2":["all","groups:read","groups:users:read"]}]}},"/groups/{groupId}/voicemail":{"get":{"tags":["groups"],"summary":"Returns information about the group voicemail","description":"","operationId":"getGroupVoicemail","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"e.g. g0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsResponse"}}},"security":[{"oauth2":["all","groups:read","groups:voicemails:read"]}]}},"/numbers":{"get":{"tags":["numbers"],"summary":"Returns all numbers","description":"","operationId":"getNumbers","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}]}},"/numbers/quickdial":{"post":{"tags":["numbers"],"summary":"Adds a quick dial number","description":"","operationId":"addQuickDialNumber","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddDirectDialRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}]}},"/numbers/quickdial/validation/{quickDialNumber}":{"get":{"tags":["numbers"],"summary":"Validate a dial number","description":"","operationId":"validateQuickDialNumber","produces":["application/json"],"parameters":[{"name":"quickDialNumber","in":"path","description":"e.g. 10","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:read"]}]}},"/numbers/quickdial/{numberId}":{"delete":{"tags":["numbers"],"summary":"Delete a quick dial number","description":"","operationId":"deleteQuickDialNumber","produces":["application/json"],"parameters":[{"name":"numberId","in":"path","description":"e.g. 1234","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}]}},"/numbers/quickdial/{quickdialId}":{"put":{"tags":["numbers"],"summary":"Changes a quick dial number","description":"","operationId":"changeQuickDialNumber","produces":["application/json"],"parameters":[{"name":"quickdialId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeDirectDialRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","numbers:write"]}]}},"/numbers/{numberId}":{"put":{"tags":["numbers"],"summary":"Changes number settings, e.g. route to endpoint","description":"","operationId":"changeNumberSettings","produces":["application/json"],"parameters":[{"name":"numberId","in":"path","description":"e.g. 1337","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeNumberSettingsRequest"}}],"responses":{"404":{"description":"Number not found"}},"security":[{"oauth2":["all","numbers:write"]}]}},"/passwordreset":{"post":{"tags":["password reset"],"summary":"Request a password change","description":"","operationId":"requestPasswordReset","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RequestPasswordResetRequest"}}],"responses":{"default":{"description":"successful operation"}}}},"/passwordreset/{nonce}":{"post":{"tags":["password reset"],"summary":"Change the password","description":"","operationId":"changePassword","produces":["application/json"],"parameters":[{"name":"nonce","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangePasswordRequest"}}],"responses":{"default":{"description":"successful operation"}}}},"/portings":{"get":{"tags":["portings"],"summary":"Returns number portings","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","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortingsResponse"}}},"security":[{"oauth2":["all","portings:read"]}]}},"/portings/{portingId}":{"delete":{"tags":["portings"],"summary":"Revoke a porting","description":"","operationId":"revokePorting","produces":["application/json"],"parameters":[{"name":"portingId","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortingsResponse"}}},"security":[{"oauth2":["all","portings:write"]}]}},"/restrictions":{"get":{"tags":["restrictions"],"summary":"Restrictions based on the users product","description":"Get restrictions for actions the authenticated user can perform for himself or another user.","operationId":"getRestrictions","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"e.g. w0","required":false,"type":"string"},{"name":"restriction","in":"query","description":"e.g. CAN_CREATE_REGISTER_DEVICE","required":false,"type":"array","items":{"type":"string","enum":["CAN_CREATE_REGISTER_DEVICE","CAN_DELETE_REGISTER_DEVICE","CAN_CREATE_MOBILE_DEVICE","CAN_DELETE_MOBILE_DEVICE","CAN_CREATE_EXTERNAL_DEVICE","CAN_DELETE_EXTERNAL_DEVICE","CAN_CHANGE_EXTERNAL_DEVICE","CAN_BOOK_PHONELINE_FEATURE","CAN_CREATE_PHONELINE_EXTENSION","CAN_DELETE_PHONELINE_EXTENSION","CAN_CREATE_QUICKDIAL_NUMBER","CAN_CHANGE_QUICKDIAL_NUMBER","CAN_DELETE_QUICKDIAL_NUMBER","CAN_GET_HISTORY","CAN_DELETE_HISTORY","CAN_CREATE_FAX_EXTENSION","CAN_DELETE_FAX_EXTENSION","CAN_BOOK_FAX_FEATURE","CAN_SEND_FAX","CAN_RECEIVE_FAX","CAN_CHANGE_DEVICE_EMERGENCY_LOCATION","CAN_ACTIVATE_SIM","MAX_PARALLEL_FORWARDINGS","MAX_FORWARDINGS","NOTIFICATION_RESTRICTIONS","GSUITE_EXTENSION"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContractRestrictionsResponse"}}},"security":[{"oauth2":["internal"]}]}},"/sessions/calls":{"post":{"tags":["sessions"],"summary":"Initiates a new call","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.","operationId":"newCall","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/NewCallRequest"}}],"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"]}]}},"/sessions/fax":{"post":{"tags":["sessions"],"summary":"Send FAX","description":"","operationId":"sendFax","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SendFaxRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendFaxSessionResponse"}},"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:fax:write"]}]}},"/sessions/fax/resend":{"post":{"tags":["sessions"],"summary":"Resend FAX","description":"","operationId":"resendFax","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ResendFaxRequest"}}],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:fax:write"]}]}},"/sessions/sms":{"post":{"tags":["sessions"],"summary":"Send SMS","description":"","operationId":"sendWebSms","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SendWebSmsRequest"}}],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sessions:write","sessions:sms:write"]}]}},"/settings/sipgateio":{"get":{"tags":["settings"],"summary":"Returns sipgate.io URLs","description":"","operationId":"getSipgateIoUrls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipgateIoUrlResponse"}},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","settings:read","settings:sipgateio:read"]}]},"put":{"tags":["settings"],"summary":"Set sipgate.io URLs","description":"","operationId":"setSipgateIoUrls","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSipgateIoAccountSettingsRequest"}}],"responses":{"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","settings:write","settings:sipgateio:write"]}]}},"/translations/{language}":{"get":{"tags":["translations"],"summary":"Returns sipgate translations","description":"","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"language","in":"path","description":"e.g. de_DE","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}}}},"/users":{"get":{"tags":["users"],"summary":"Returns all users","description":"","operationId":"getAllUsers","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersResponse"}}},"security":[{"oauth2":["all","users:read"]}]}},"/users/{userId}":{"get":{"tags":["users"],"summary":"Returns a user","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserResponse"}},"404":{"description":"User not found"}},"security":[{"oauth2":["all","users:read"]}]}},"/users/{userId}/defaultdevice":{"put":{"tags":["users"],"summary":"Sets default device for given user","description":"","operationId":"setDefaultDevice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetDefaultDeviceRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","users:read","users:defaultdevice:write"]}]}},"/{userId}/devices":{"get":{"tags":["devices"],"summary":"Returns all user devices","description":"","operationId":"getDevices","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevicesResponse"}}},"security":[{"oauth2":["all","devices:read"]}]},"post":{"tags":["devices"],"summary":"Creates a new device for the user.","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","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateDeviceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}]}},"/{userId}/devices/external":{"post":{"tags":["devices"],"summary":"Creates a new external device for the user.","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":"createDevice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateExternalDeviceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}]}},"/{userId}/devices/mobile":{"post":{"tags":["devices"],"summary":"Creates a new mobile device for the user.","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":"createDevice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateMobileDeviceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MobileDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}]}},"/{userId}/devices/register":{"post":{"tags":["devices"],"summary":"Creates a new register device for the user.","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","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateRegisterDeviceRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RegisterDeviceResponse"}}},"security":[{"oauth2":["all","devices:write"]}]}},"/{userId}/devices/{deviceId}/contingents":{"get":{"tags":["devices"],"summary":"Returns all user device contingents","description":"","operationId":"getDeviceContingents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. y0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DeviceContingentsResponse"}}},"security":[{"oauth2":["all","devices:read"]}]}},"/{userId}/devices/{deviceId}/sim":{"post":{"tags":["devices"],"summary":"Activate a sim card","description":"","operationId":"activateSim","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. y0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActivateSimRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:sim:write"]}]},"delete":{"tags":["devices"],"summary":"Deactivate a sim card","description":"","operationId":"deactivateSim","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. y0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","devices:write","devices:sim:write"]}]}},"/{userId}/devices/{deviceId}/sim/orders":{"post":{"tags":["devices"],"summary":"Order a new SIM card","description":"","operationId":"orderSim","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. y0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrderSimRequest"}}],"responses":{"403":{"description":"User or device not found"}},"security":[{"oauth2":["all","devices:write","devices:sim:write","devices:sims:orders:write"]}]}},"/{userId}/faxlines":{"get":{"tags":["faxlines"],"summary":"Returns all fax lines","description":"","operationId":"getFaxlines","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlinesResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:read"]}]},"post":{"tags":["faxlines"],"summary":"Creates a new faxline for the user","description":"","operationId":"createFaxline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineResponse"}}},"security":[{"oauth2":["all","faxlines:write"]}]}},"/{userId}/faxlines/{faxlineId}":{"put":{"tags":["faxlines"],"summary":"Change faxline alias","description":"","operationId":"changeFaxlineAlias","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"responses":{"404":{"description":"Faxline not found"}},"security":[{"oauth2":["all","faxlines:write"]}]},"delete":{"tags":["faxlines"],"summary":"delete faxline","description":"","operationId":"deleteFaxline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","faxlines:write"]}]}},"/{userId}/faxlines/{faxlineId}/callerid":{"get":{"tags":["faxlines"],"summary":"Caller ID for faxline","description":"","operationId":"getFaxlineCallerId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxlineCallerIdResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:read"]}]},"put":{"tags":["faxlines"],"summary":"Change caller ID for faxline","description":"","operationId":"changeFaxlineCallerIdSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxlineCallerIdRequest"}}],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:write"]}]}},"/{userId}/faxlines/{faxlineId}/numbers":{"get":{"tags":["faxlines"],"summary":"Returns all phone numbers","description":"","operationId":"getFaxlineNumbers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","faxlines:read","faxlines:numbers:read"]}]}},"/{userId}/faxlines/{faxlineId}/tagline":{"put":{"tags":["faxlines"],"summary":"Change tagline for faxline","description":"","operationId":"changeTagline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"faxlineId","in":"path","description":"e.g. f0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FaxlineTaglineRequest"}}],"responses":{"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","faxlines:write"]}]}},"/{userId}/history":{"get":{"tags":["history"],"summary":"Returns the history of calls and voicemails","description":"","operationId":"getHistory","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"query","description":"e.g. p0","required":false,"type":"string"},{"name":"types","in":"query","description":"e.g. VOICEMAIL","required":false,"type":"array","items":{"type":"string","enum":["CALL","VOICEMAIL","SMS","FAX"]},"collectionFormat":"multi"},{"name":"directions","in":"query","description":"e.g. MISSED_INCOMING","required":false,"type":"array","items":{"type":"string","enum":["MISSED_INCOMING","INCOMING","OUTGOING","MISSED_OUTGOING"]},"collectionFormat":"multi"},{"name":"offset","in":"query","description":"e.g. 42","required":false,"type":"integer","default":0,"maximum":2.147483647E9,"minimum":0.0,"format":"int32"},{"name":"limit","in":"query","description":"e.g. 23","required":false,"type":"integer","default":10,"maximum":1000.0,"minimum":0.0,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryResponse"}}},"security":[{"oauth2":["all","history:read"]}]}},"/{userId}/history/{entryId}":{"get":{"tags":["history"],"summary":"Returns a specific history entry by id","description":"","operationId":"getHistoryById","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"entryId","in":"path","description":"e.g. 1337","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryEntryResponse"}}},"security":[{"oauth2":["all","history:read"]}]},"delete":{"tags":["history"],"summary":"Deletes a history entry","description":"","operationId":"deleteHistoryEntry","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"entryId","in":"path","description":"e.g. 1337","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","history:write"]}]}},"/{userId}/notifications":{"get":{"tags":["notifications"],"summary":"Get notifications","description":"","operationId":"getNotifications","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}}},"security":[{"oauth2":["all","notifications:read"]}]}},"/{userId}/notifications/call/email":{"post":{"tags":["notifications"],"summary":"Add a new call email notification","description":"","operationId":"addCallEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddCallEmailNotificationRequest"}}],"responses":{"403":{"description":"Limit reached"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/call/sms":{"post":{"tags":["notifications"],"summary":"Add a new call sms notification","description":"","operationId":"addCallEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddCallSmsNotificationRequest"}}],"responses":{"403":{"description":"Limit reached"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/fax/email":{"post":{"tags":["notifications"],"summary":"Add a new fax email notification","description":"","operationId":"addFaxEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxEmailNotificationRequest"}}],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/fax/report":{"post":{"tags":["notifications"],"summary":"Add a new fax report email notification","description":"","operationId":"addFaxReportEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxReportEmailNotificationRequest"}}],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/fax/sms":{"post":{"tags":["notifications"],"summary":"Add a new fax sms notification","description":"","operationId":"addFaxSmsNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddFaxSmsNotificationRequest"}}],"responses":{"403":{"description":"Fax feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/sms/email":{"post":{"tags":["notifications"],"summary":"Add a new email notification for incoming sms","description":"","operationId":"addSmsEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddSmsEmailNotificationRequest"}}],"responses":{"403":{"description":"SMSToMail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/voicemail/email":{"post":{"tags":["notifications"],"summary":"Add a new voicemail email notification","description":"","operationId":"addVoicemailEmailNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddVoicemailEmailVoicemailNotificationRequest"}}],"responses":{"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/voicemail/sms":{"post":{"tags":["notifications"],"summary":"Add a new voicemail sms notification","description":"","operationId":"addVoicemailSmsNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddVoicemailSmslVoicemailNotificationRequest"}}],"responses":{"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/notifications/{notificationId}":{"delete":{"tags":["notifications"],"summary":"Delete a notification","description":"","operationId":"deleteNotification","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"notificationId","in":"path","description":"e.g. 42","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","notifications:write"]}]}},"/{userId}/numbers":{"get":{"tags":["numbers"],"summary":"Returns all user numbers","description":"","operationId":"getNumbers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumbersResponse"}}},"security":[{"oauth2":["all","numbers:read"]}]}},"/{userId}/phonelines":{"get":{"tags":["phonelines"],"summary":"Returns all telephone lines","description":"","operationId":"getPhonelines","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelinesResponse"}}},"security":[{"oauth2":["all","phonelines:read"]}]},"post":{"tags":["phonelines"],"summary":"Creates a new phoneline for the user","description":"","operationId":"createPhoneline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineResponse"}}},"security":[{"oauth2":["all","phonelines:write"]}]}},"/{userId}/phonelines/{phonelineId}":{"put":{"tags":["phonelines"],"summary":"Change phoneline alias","description":"","operationId":"changePhoneline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"responses":{"404":{"description":"Phoneline not found"}},"security":[{"oauth2":["all","phonelines:write"]}]},"delete":{"tags":["phonelines"],"summary":"delete phoneline","description":"","operationId":"deletePhoneline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"404":{"description":"Phoneline not found"}},"security":[{"oauth2":["all","phonelines:write"]}]}},"/{userId}/phonelines/{phonelineId}/blockanonymous":{"get":{"tags":["phonelines"],"summary":"Returns settings for block anonymous calls","description":"","operationId":"getBlockAnonymousSetting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineBlockAnonymousResponse"}}},"security":[{"oauth2":["all","phonelines:blockanonymous:read"]}]},"put":{"tags":["phonelines"],"summary":"Sets settings for block anonymous calls","description":"","operationId":"setBlockAnonymousSetting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetBlockAnonymousSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineBlockAnonymousResponse"}}},"security":[{"oauth2":["all","phonelines:blockanonymous:write"]}]}},"/{userId}/phonelines/{phonelineId}/busyonbusy":{"get":{"tags":["phonelines"],"summary":"Returns settings for busy on busy","description":"","operationId":"getBusyOnBusySetting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineBusyOnBusyResponse"}}},"security":[{"oauth2":["all","phonelines:busyonbusy:read"]}]},"put":{"tags":["phonelines"],"summary":"Sets settings for busy on busy","description":"","operationId":"setBusyOnBusySetting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetBusyOnBusySettingsRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:busyonbusy:write"]}]}},"/{userId}/phonelines/{phonelineId}/devices":{"get":{"tags":["phonelines"],"summary":"Returns all devices","description":"","operationId":"getDevices","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevicesResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:devices:read"]}]},"post":{"tags":["phonelines"],"summary":"set routing for device to phoneline","description":"","operationId":"routeDevices","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RouteDeviceRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:devices:write"]}]}},"/{userId}/phonelines/{phonelineId}/devices/{deviceId}":{"delete":{"tags":["phonelines"],"summary":"delete routing for device to phoneline","description":"","operationId":"deleteDeviceRouting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"deviceId","in":"path","description":"e.g. e0","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:devices:write"]}]}},"/{userId}/phonelines/{phonelineId}/forwardings":{"get":{"tags":["phonelines"],"summary":"Returns all forwardings","description":"","operationId":"getPhonelineForwardings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ForwardingsResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:forwardings:read"]}]},"put":{"tags":["phonelines"],"summary":"Change forwarding settings","description":"","operationId":"setPhonelineForwardingSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetForwardingsRequest"}}],"responses":{"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"]}]}},"/{userId}/phonelines/{phonelineId}/numbers":{"get":{"tags":["phonelines"],"summary":"Returns all phone numbers","description":"","operationId":"getPhonelineNumbers","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EndpointNumbersResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:numbers:read"]}]}},"/{userId}/phonelines/{phonelineId}/parallelforwardings":{"get":{"tags":["phonelines"],"summary":"Returns all parallel forwardings","description":"","operationId":"getPhonelineParallelForwardings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParallelForwardingsResponse"}},"403":{"description":"Feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:parallelforwardings:read"]}],"deprecated":true},"post":{"tags":["phonelines"],"summary":"Add parallel forwarding","description":"","operationId":"addParallelForwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetParallelForwardingRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"deprecated":true}},"/{userId}/phonelines/{phonelineId}/parallelforwardings/{parallelForwardingId}":{"put":{"tags":["phonelines"],"summary":"Change parallel forwarding","description":"","operationId":"changeParallelForwardingSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"parallelForwardingId","in":"path","description":"e.g. x0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetParallelForwardingRequest"}}],"responses":{"404":{"description":"Parallel forwarding not found"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"deprecated":true},"delete":{"tags":["phonelines"],"summary":"Delete parallel forwarding","description":"","operationId":"deleteParallelForwardingSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"parallelForwardingId","in":"path","description":"e.g. x0","required":true,"type":"string"}],"responses":{"404":{"description":"Parallel forwarding not found"}},"security":[{"oauth2":["all","phonelines:write","phonelines:parallelforwardings:write"]}],"deprecated":true}},"/{userId}/phonelines/{phonelineId}/sipgateio":{"get":{"tags":["phonelines"],"summary":"Returns sipgate.io settings","description":"","operationId":"getSipgateIoSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhonelineSipgateIoResponse"}},"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:sipgateio:read"]}]},"put":{"tags":["phonelines"],"summary":"Set sipgate.io URLs","description":"","operationId":"setSipgateIoSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSipgateIoPhonelineSettingsRequest"}}],"responses":{"403":{"description":"sipgate.io feature not booked"}},"security":[{"oauth2":["all","phonelines:write","phonelines:sipgateio:write"]}]}},"/{userId}/phonelines/{phonelineId}/sipgateio/log":{"get":{"tags":["phonelines"],"summary":"Returns sipgate.io debug log","description":"","operationId":"getSipgateIoLogs","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"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"]}]}},"/{userId}/phonelines/{phonelineId}/voicemails":{"get":{"tags":["phonelines"],"summary":"Returns all voicemails","description":"","operationId":"getVoicemails","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsResponse"}},"403":{"description":"Voicemail feature not booked"}},"security":[{"oauth2":["all","phonelines:read","phonelines:voicemails:read"]}]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}":{"put":{"tags":["phonelines"],"summary":"Change voicemail settings","description":"","operationId":"changeVoicemailSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"voicemailId","in":"path","description":"e.g. v0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeVoicemailRequest"}}],"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"]}]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}/greetings":{"get":{"tags":["phonelines"],"summary":"Returns all greetings","description":"","operationId":"getPhonelineVoicemailGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"voicemailId","in":"path","description":"e.g. v0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingsResponse"}}},"security":[{"oauth2":["all","phonelines:read","phonelines:voicemails:read","phonelines:voicemails:greetings:read"]}]},"post":{"tags":["phonelines"],"summary":"Upload your base64 encoded OGG/MP3/WAV greeting","description":"","operationId":"addGreeting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"voicemailId","in":"path","description":"e.g. v0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AddGreetingRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingsResponse"}}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}]}},"/{userId}/phonelines/{phonelineId}/voicemails/{voicemailId}/greetings/{greetingId}":{"put":{"tags":["phonelines"],"summary":"Change greeting settings","description":"","operationId":"changePhonelineVoicemailGreeting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"voicemailId","in":"path","description":"e.g. v0","required":true,"type":"string"},{"name":"greetingId","in":"path","description":"e.g. 42","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ChangeVoicemailGreetingRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}]},"delete":{"tags":["phonelines"],"summary":"Deletes a greeting","description":"","operationId":"deletePhonlineVoicemailGreeting","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"phonelineId","in":"path","description":"e.g. p0","required":true,"type":"string"},{"name":"voicemailId","in":"path","description":"e.g. v0","required":true,"type":"string"},{"name":"greetingId","in":"path","description":"e.g. 42","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","phonelines:write","phonelines:voicemails:write","phonelines:voicemails:greetings:write"]}]}},"/{userId}/sms":{"get":{"tags":["sms"],"summary":"Returns all short message services","description":"","operationId":"getSmsExtensions","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsExtensionsResponse"}}},"security":[{"oauth2":["all","sms:read"]}]}},"/{userId}/sms/{smsId}":{"put":{"tags":["sms"],"summary":"Change short message service alias","description":"","operationId":"changePhoneline","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetAliasRequest"}}],"responses":{"404":{"description":"Short message service not found"}},"security":[{"oauth2":["all","sms:write"]}]}},"/{userId}/sms/{smsId}/callerids":{"get":{"tags":["sms"],"summary":"Returns all callerids for the short message service","description":"","operationId":"getSmsCallerIds","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsCallerIdsResponse"}}},"security":[{"oauth2":["all","sms:read","sms:callerid:read"]}]},"post":{"tags":["sms"],"summary":"adds a callerid","description":"","operationId":"addCallerId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SmsCallerIdRequest"}}],"responses":{"402":{"description":"Insufficient funds"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}]}},"/{userId}/sms/{smsId}/callerids/{callerId}":{"put":{"tags":["sms"],"summary":"changes a callerid","description":"","operationId":"editCallerId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"},{"name":"callerId","in":"path","description":"e.g. 4223","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/SetSmsCallerIdRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}]},"delete":{"tags":["sms"],"summary":"Deletes a callerid","description":"","operationId":"deleteSmsCallerId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"},{"name":"callerId","in":"path","description":"e.g. 4223","required":true,"type":"integer","format":"int32"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}]}},"/{userId}/sms/{smsId}/callerids/{callerId}/verification":{"post":{"tags":["sms"],"summary":"verifies a callerid","description":"","operationId":"verifyCallerId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"e.g. w0","required":true,"type":"string"},{"name":"smsId","in":"path","description":"e.g. s0","required":true,"type":"string"},{"name":"callerId","in":"path","description":"e.g. 1337","required":true,"type":"integer","format":"int32"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/VerifySmsCallerIdRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","sms:write","sms:callerid:write"]}]}},"/authorization/oauth2/clients":{"get":{"tags":["authorization"],"summary":"List all OAuth 2.0 clients","operationId":"getClients","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClients"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:read"]}],"x-contentType":"application/json","x-accepts":"application/json"},"post":{"tags":["authorization"],"summary":"Create a new OAuth 2.0 client","operationId":"createClient","parameters":[{"in":"body","name":"client","required":true,"schema":{"required":["description","name","redirectUris","webOrigins"],"properties":{"name":{"type":"string","example":"Example name","description":"Name of the application the client is intended to use with"},"description":{"type":"string","example":"Example description","description":"Short description of the application the client is intended to use with"},"redirectUris":{"type":"array","example":["https://*.example.com/*"],"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","items":{"type":"string"}},"webOrigins":{"type":"array","example":["http://*.example.com","https://*.example.com"],"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","items":{"type":"string"}}}}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"x-contentType":"application/json","x-accepts":"application/json"}},"/authorization/oauth2/clients/{clientId}":{"get":{"tags":["authorization"],"summary":"Get a specific OAuth 2.0 client","operationId":"getClient","parameters":[{"name":"clientId","in":"path","description":"The unique OAuth 2.0 client identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:read"]}],"x-contentType":"application/json","x-accepts":"application/json"},"put":{"tags":["authorization"],"summary":"Update an existing OAuth 2.0 client","operationId":"updateClient","parameters":[{"name":"clientId","in":"path","description":"The unique OAuth 2.0 client identifier","required":true,"type":"string"},{"in":"body","name":"client","required":true,"schema":{"required":["description","name","redirectUris","webOrigins"],"properties":{"name":{"type":"string","example":"Example name","description":"Name of the application the client is intended to use with"},"description":{"type":"string","example":"Example description","description":"Short description of the application the client is intended to use with"},"redirectUris":{"type":"array","example":["https://*.example.com/*"],"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","items":{"type":"string"}},"webOrigins":{"type":"array","example":["http://*.example.com","https://*.example.com"],"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","items":{"type":"string"}}}}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuthClient"}}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"x-contentType":"application/json","x-accepts":"application/json"},"delete":{"tags":["authorization"],"summary":"Delete an existing OAuth 2.0 client","operationId":"deleteClient","parameters":[{"name":"clientId","in":"path","description":"The unique OAuth 2.0 client identifier","required":true,"type":"string"}],"responses":{"200":{"description":"Success"}},"security":[{"oauth2":["all","authorization:oauth2:clients:write"]}],"x-contentType":"application/json","x-accepts":"application/json"}},"/contacts":{"get":{"tags":["contacts"],"summary":"Get all contacts","description":"","operationId":"getContacts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsResponse"}}},"security":[{"oauth2":["all","contacts:read"]}]},"delete":{"tags":["contacts"],"summary":"Delete all contacts","description":"","operationId":"deleteContacts","produces":["application/json"],"parameters":[],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","contacts:write"]}]}},"/contacts/import/csv":{"post":{"tags":["contacts"],"summary":"Import contacts from CSV file","description":"CSV files should match the following format:<br /><pre>firstname,lastname,number\nAda,Lovelace,+4915799912345\nAlan,Turing,+4915799912345\n</pre>","operationId":"importFromCSV","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ImportCSVRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","contacts:write"]}]}},"/contacts/import/google":{"post":{"tags":["contacts"],"summary":"Import contacts from Google","description":"","operationId":"importFromGoogle","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ImportGoogleRequest"}}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","contacts:write"]}]}},"/contacts/{contactid}":{"delete":{"tags":["contacts"],"summary":"Delete a single contact","description":"","operationId":"deleteAllContacts","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"contactid","in":"path","required":true,"type":"string"}],"responses":{"default":{"description":"successful operation"}},"security":[{"oauth2":["all","contacts:write"]}]}},"/calls":{"get":{"tags":["rtcm"],"summary":"List all calls currently in progress","description":"","operationId":"getCalls","consumes":["application/json"],"produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/Calls"}}},"security":[{"oauth2":["all","rtcm:read"]}]}},"/calls/{callId}":{"delete":{"tags":["rtcm"],"summary":"Hang up call","description":"","operationId":"hangupCall","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/announcements":{"post":{"tags":["rtcm"],"summary":"Start playing a new announcement to all participants","description":"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","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/AnnouncementRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/dtmf":{"post":{"tags":["rtcm"],"summary":"Send DTMF tone sequences to all participants","description":"","operationId":"sendCallDtmf","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DtmfRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/hold":{"put":{"tags":["rtcm"],"summary":"Hold/Resume all participants","description":"","operationId":"setCallHold","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BooleanRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/muted":{"put":{"tags":["rtcm"],"summary":"Mute/Unmute yourself","description":"","operationId":"setCallMuted","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BooleanRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/recording":{"put":{"tags":["rtcm"],"summary":"Start or stop a call recording","description":"","operationId":"setCallRecording","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RecordingRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}},"/calls/{callId}/transfer":{"post":{"tags":["rtcm"],"summary":"Transfer call","description":"","operationId":"transferCall","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"callId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Call not found"}},"security":[{"oauth2":["all","rtcm:write"]}]}}},"definitions":{"AccountResponse":{"type":"object","properties":{"company":{"type":"string","example":"Love sipgate"},"mainProductType":{"type":"string","enum":["AFFILIATE","FORMER_AFFILIATE","BASIC","FORMER_BASIC","SIMQUADRAT","FORMER_SIMQUADRAT","TEAM","FORMER_TEAM","TRUNKING","FORMER_TRUNKING"]},"logoUrl":{"type":"string"},"verified":{"type":"boolean","default":false}}},"AccountVerificationRequest":{"type":"object","required":["verificationCode"],"properties":{"verificationCode":{"type":"string","example":"ABC123","readOnly":true}}},"ActivateSimRequest":{"type":"object","properties":{"simId":{"type":"string","example":"1234567"}}},"ActiveRouting":{"type":"object","properties":{"id":{"type":"string"},"alias":{"type":"string","example":"Alan Turing"}}},"AddCallEmailNotificationRequest":{"type":"object","required":["cause","direction","email","endpointId"],"properties":{"endpointId":{"type":"string","example":"e0/p0"},"direction":{"type":"string","example":"INCOMING"},"cause":{"type":"string","example":"MISSED"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"AddCallSmsNotificationRequest":{"type":"object","required":["cause","direction","endpointId","number"],"properties":{"endpointId":{"type":"string","example":"e0/p0"},"direction":{"type":"string","example":"INCOMING"},"cause":{"type":"string","example":"MISSED"},"number":{"type":"string","example":"+4915799912345"}}},"AddDirectDialRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","example":"w0"},"number":{"type":"string"}}},"AddFaxEmailNotificationRequest":{"type":"object","required":["direction","email","faxlineId"],"properties":{"faxlineId":{"type":"string","example":"f0"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"email":{"type":"string","example":"grace.hopper@example.com"}}},"AddFaxReportEmailNotificationRequest":{"type":"object","required":["email","faxlineId"],"properties":{"faxlineId":{"type":"string","example":"f0"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"AddFaxSmsNotificationRequest":{"type":"object","required":["direction","faxlineId","number"],"properties":{"faxlineId":{"type":"string","example":"f0"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"number":{"type":"string","example":"+4915799912345"}}},"AddGreetingRequest":{"type":"object","properties":{"filename":{"type":"string","example":"greeting.mp3"},"base64Content":{"type":"string","example":"RG8uIE9yIGRvIG5vdC4gVGhlcmUgaXMgbm8gdHJ5LiAtLVlvZGEK","minLength":0,"maxLength":8000000}}},"AddSmsEmailNotificationRequest":{"type":"object","required":["email","endpointId"],"properties":{"endpointId":{"type":"string","example":"y0"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"AddVoicemailEmailVoicemailNotificationRequest":{"type":"object","required":["email","voicemailId"],"properties":{"voicemailId":{"type":"string","example":"v0"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"AddVoicemailSmslVoicemailNotificationRequest":{"type":"object","required":["number","voicemailId"],"properties":{"voicemailId":{"type":"string","example":"v0"},"number":{"type":"string","example":"+4915799912345"}}},"AddressResponse":{"type":"object","properties":{"poBox":{"type":"string"},"extendedAddress":{"type":"string"},"streetAddress":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"}}},"AddressesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/AddressResponse"}}}},"AnnouncementRequest":{"type":"object","required":["url"],"properties":{"url":{"type":"string","example":"https://static.sipgate.com/examples/wav/example.wav","description":"The URL pointing to the announcement WAV file."}}},"ApiUrlsResponse":{"type":"object","properties":{"accountUrl":{"type":"string"},"accountVerifiedUrl":{"type":"string"},"addressUrl":{"type":"string"},"addressesUrl":{"type":"string"},"addressNumbersUrl":{"type":"string"},"authorizationOauthClientsUrl":{"type":"string"},"authorizationOauthClientUrl":{"type":"string"},"authorizationTokenUrl":{"type":"string"},"balanceUrl":{"type":"string"},"contactsUrl":{"type":"string"},"internalContactsUrl":{"type":"string"},"deviceCallerIdUrl":{"type":"string"},"deviceUrl":{"type":"string"},"devicesTariffAnnouncementUrl":{"type":"string"},"devicesSingleRowDisplayUrl":{"type":"string"},"deviceSimOrdersUrl":{"type":"string"},"faxlinesUrl":{"type":"string"},"faxlineUrl":{"type":"string"},"faxlineNumbersUrl":{"type":"string"},"groupsUrl":{"type":"string"},"groupUserUrl":{"type":"string"},"groupNumbersUrl":{"type":"string"},"historyEntryUrl":{"type":"string"},"historyUrl":{"type":"string"},"notificationsUrl":{"type":"string"},"numberUrl":{"type":"string"},"numbersUrl":{"type":"string"},"addDirectDialUrl":{"type":"string"},"changeDirectDialUrl":{"type":"string"},"deleteDirectDialUrl":{"type":"string"},"phonelineUrl":{"type":"string"},"phonelineBlockAnonymousUrl":{"type":"string"},"phonelineBusyOnBusyUrl":{"type":"string"},"phonelineDevicesUrl":{"type":"string"},"phonelineForwardingsUrl":{"type":"string"},"phonelineNumbersUrl":{"type":"string"},"phonelinesParallelForwardingUrl":{"type":"string"},"phonelinesParallelForwardingsUrl":{"type":"string"},"phonelineSipgateIoUrl":{"type":"string"},"phonelineSipgateIoLogUrl":{"type":"string"},"phonelineVoicemailGreetingUrl":{"type":"string"},"phonelineVoicemailGreetingsUrl":{"type":"string"},"phonelineVoicemailUrl":{"type":"string"},"phonelineVoicemailsUrl":{"type":"string"},"phonelinesUrl":{"type":"string"},"portingUrl":{"type":"string"},"portingsUrl":{"type":"string"},"restrictionsUrl":{"type":"string"},"sessionsCallUrl":{"type":"string"},"settingsSipgateioUrl":{"type":"string"},"smsUrl":{"type":"string"},"smsCallerIdsUrl":{"type":"string"},"translationsUrl":{"type":"string"},"userInfoUrl":{"type":"string"},"userUrl":{"type":"string"},"userDefaultDeviceUrl":{"type":"string"},"userDevicesUrl":{"type":"string"},"userExternalDevicesUrl":{"type":"string"},"userMobileDevicesUrl":{"type":"string"},"userRegisterDevicesUrl":{"type":"string"},"usersUrl":{"type":"string"}}},"BalanceResponse":{"type":"object","properties":{"amount":{"type":"integer","format":"int32","example":"35000 (Amount multiplied by 10000 (35000/10000=EUR 3.50))"},"currency":{"type":"string","example":"EUR"}}},"BooleanRequest":{"type":"object","required":["value"],"properties":{"value":{"type":"boolean","example":"true","description":"true or false","default":false}}},"Call":{"type":"object","required":["callId","hold","muted","participants","recording"],"properties":{"callId":{"type":"string","example":"ABCDEF0123456789","description":"The unique call identifier"},"muted":{"type":"boolean","example":"false","description":"The call is muted","default":false},"recording":{"type":"boolean","example":"false","description":"The call is being recorded","default":false},"hold":{"type":"boolean","example":"false","description":"The call is on hold","default":false},"participants":{"type":"array","items":{"$ref":"#/definitions/Participant"}}}},"CallEmailTarget":{"type":"object","properties":{"id":{"type":"string","example":"42"},"email":{"type":"string","example":"grace.hopper@example.com"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"cause":{"type":"string","enum":["MISSED","SUCCESSFUL"]}}},"CallNotificationResponse":{"type":"object","properties":{"endpointId":{"type":"string","example":"f0/v0/p0"},"endpointAlias":{"type":"string","example":"Fax/Voicemail of Grace Hopper"},"emails":{"type":"array","items":{"$ref":"#/definitions/CallEmailTarget"}},"sms":{"type":"array","items":{"$ref":"#/definitions/CallSmsTarget"}}}},"CallSmsTarget":{"type":"object","properties":{"id":{"type":"string","example":"1337"},"number":{"type":"string","example":"+4915799912345"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"cause":{"type":"string","enum":["MISSED","SUCCESSFUL"]}}},"CallerIdRequest":{"type":"object","properties":{"value":{"type":"string","example":"+4915799912345"}}},"CallerIdResponse":{"type":"object","properties":{"value":{"type":"string","example":"+4915799912345"}}},"Calls":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Call"}}}},"ChangeDeviceRequest":{"type":"object","properties":{"dnd":{"type":"boolean","default":false},"emergencyAddressId":{"type":"integer","format":"int32"}}},"ChangeDirectDialRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","example":"w0"},"number":{"type":"string"}}},"ChangeExternalDeviceIncomingCallDisplayRequest":{"type":"object","required":["incomingCallDisplay"],"properties":{"incomingCallDisplay":{"type":"string","enum":["CALLED_NUMBER","CALLER_NUMBER"]}}},"ChangeExternalDeviceTargetNumberRequest":{"type":"object","properties":{"number":{"type":"string","example":"+4915799912345"}}},"ChangeNumberSettingsRequest":{"type":"object","properties":{"endpointId":{"type":"string","example":"p0"},"releaseForMnp":{"type":"boolean","example":false,"default":false},"quickDial":{"type":"boolean","example":false,"default":false}}},"ChangePasswordRequest":{"type":"object","properties":{"password":{"type":"string"},"passwordRepeat":{"type":"string"}}},"ChangeVoicemailGreetingRequest":{"type":"object","properties":{"active":{"type":"boolean","default":false}}},"ChangeVoicemailRequest":{"type":"object","required":["active","transcription"],"properties":{"timeout":{"type":"integer","format":"int32","minimum":0.0},"active":{"type":"boolean","default":false},"transcription":{"type":"boolean","default":false}}},"ContactResponse":{"type":"object","properties":{"id":{"type":"string","example":"b3d9af4a-78f9-11e6-8b77-86f30ca893d3"},"name":{"type":"string","example":"Ada Lovelace"},"picture":{"type":"string","example":"4AAQSkZJRgABAQAAAQABAAD..."},"emails":{"type":"array","items":{"$ref":"#/definitions/EMailResponse"}},"numbers":{"type":"array","items":{"$ref":"#/definitions/NumberResponse"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/AddressResponse"}},"organization":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}},"ContactsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ContactResponse"}}}},"ContingentResponse":{"type":"object","properties":{"type":{"type":"string","example":"DATA_FAST"},"amount":{"type":"integer","format":"int32","example":2500},"used":{"type":"integer","format":"int32","example":1000},"left":{"type":"integer","format":"int32","example":1500},"unit":{"type":"string","example":"KILOBYTE"},"expires":{"type":"string","example":"2016-02-10T14:19:39Z"}}},"ContractRestrictionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/RestrictionItem"}}}},"CreateDeviceRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["REGISTER","MOBILE","EXTERNAL"]},"alias":{"type":"string","example":"VoIP phone of Grace Hopper"}}},"CreateExternalDeviceRequest":{"type":"object","properties":{"alias":{"type":"string","example":"External phone of Grace Hopper"},"number":{"type":"string","example":"+4915799912345"}}},"CreateMobileDeviceRequest":{"type":"object","properties":{"alias":{"type":"string","example":"Mobile phone phone of Grace Hopper"}}},"CreateRegisterDeviceRequest":{"type":"object","properties":{"alias":{"type":"string","example":"VoIP phone of Grace Hopper"}}},"CreateSessionRequest":{"type":"object","required":["password","username"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},"CredentialsResponse":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"sipServer":{"type":"string"},"outboundProxy":{"type":"string"},"sipServerWebsocketUrl":{"type":"string"}}},"DeviceContingentsResponse":{"type":"object","properties":{"contingents":{"type":"array","items":{"$ref":"#/definitions/ContingentResponse"}}}},"DeviceResponse":{"type":"object","properties":{"id":{"type":"string","example":"e0"},"alias":{"type":"string","example":"VoIP phone of Grace Hopper"},"type":{"type":"string","enum":["REGISTER","MOBILE","EXTERNAL"]},"online":{"type":"boolean","default":false},"dnd":{"type":"boolean","default":false},"activePhonelines":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"activeGroups":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}}}},"DevicesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/DeviceResponse"}}}},"DtmfRequest":{"type":"object","required":["sequence"],"properties":{"sequence":{"type":"string","example":"123456","description":"DTMF sequence to send"}}},"EMailResponse":{"type":"object","properties":{"email":{"type":"string","example":"user@example.com"},"type":{"type":"array","items":{"type":"string"}}}},"EmailTarget":{"type":"object","properties":{"id":{"type":"string","example":"42"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"EndpointNumbersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/NumberResponse"}}}},"EventResponse":{"type":"object","properties":{"eventId":{"type":"string"},"eventType":{"type":"string"},"payload":{"type":"object","additionalProperties":{"type":"string"}}}},"EventsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/EventResponse"}}}},"ExternalDeviceResponse":{"type":"object","properties":{"id":{"type":"string","example":"e0"},"alias":{"type":"string","example":"VoIP phone of Grace Hopper"},"type":{"type":"string","enum":["REGISTER","MOBILE","EXTERNAL"]},"online":{"type":"boolean","default":false},"dnd":{"type":"boolean","default":false},"activePhonelines":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"activeGroups":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"number":{"type":"string","example":"+4915799912345"},"incomingCallDisplayState":{"type":"string","enum":["CALLED_NUMBER","CALLER_NUMBER"]}}},"FaxEmailTarget":{"type":"object","properties":{"id":{"type":"string","example":"42"},"email":{"type":"string","example":"grace.hopper@example.com"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]}}},"FaxNotificationResponse":{"type":"object","properties":{"endpointId":{"type":"string","example":"f0/v0/p0"},"endpointAlias":{"type":"string","example":"Fax/Voicemail of Grace Hopper"},"emails":{"type":"array","items":{"$ref":"#/definitions/FaxEmailTarget"}},"sms":{"type":"array","items":{"$ref":"#/definitions/FaxSmsTarget"}},"reports":{"type":"array","items":{"$ref":"#/definitions/ReportTarget"}}}},"FaxSmsTarget":{"type":"object","properties":{"id":{"type":"string","example":"1337"},"number":{"type":"string","example":"+4915799912345"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]}}},"FaxlineCallerIdRequest":{"type":"object","properties":{"value":{"type":"string","example":"+4921112345678"}}},"FaxlineCallerIdResponse":{"type":"object","properties":{"value":{"type":"string","example":"+4915799912345"}}},"FaxlineResponse":{"type":"object","properties":{"id":{"type":"string","example":"f0"},"alias":{"type":"string","example":"Alexander Bain's fax"},"tagline":{"type":"string","example":"Example Ltd."},"canSend":{"type":"boolean","default":false},"canReceive":{"type":"boolean","default":false}}},"FaxlineTaglineRequest":{"type":"object","properties":{"value":{"type":"string","example":"Example Ltd."}}},"FaxlinesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/FaxlineResponse"}}}},"Forwarding":{"type":"object","properties":{"destination":{"type":"string","example":"+4915799912345"},"timeout":{"type":"integer","format":"int32","maximum":600.0},"active":{"type":"boolean","default":false}}},"ForwardingResponse":{"type":"object","properties":{"alias":{"type":"string","example":"Accounting group"},"destination":{"type":"string","example":"p1"},"timeout":{"type":"integer","format":"int32"},"active":{"type":"boolean","default":false}}},"ForwardingsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ForwardingResponse"}}}},"GreetingResponse":{"type":"object","properties":{"id":{"type":"string","example":"42"},"alias":{"type":"string","example":"My Greeting"},"greetingUrl":{"type":"string","example":"https://www.example.com/greeting.mp3"},"active":{"type":"boolean","default":false}}},"GreetingsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/GreetingResponse"}}}},"GroupNumbersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/NumberResponse"}}}},"GroupResponse":{"type":"object","properties":{"id":{"type":"string","example":"g0"},"alias":{"type":"string","example":"Turings Group"},"groupNumbersUrl":{"type":"string"},"groupUsersUrl":{"type":"string"}}},"GroupUserResponse":{"type":"object","properties":{"id":{"type":"string","example":"w0"},"firstname":{"type":"string","example":"Ada"},"lastname":{"type":"string","example":"Lovelace"},"userUrl":{"type":"string"}}},"GroupUsersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/GroupUserResponse"}}}},"GroupsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/GroupResponse"}}}},"HistoryEntryResponse":{"type":"object","properties":{"id":{"type":"string","example":"100001234"},"source":{"example":"anonymous","$ref":"#/definitions/Number"},"target":{"example":"01579-9912345","$ref":"#/definitions/Number"},"sourceAlias":{"type":"string","example":"Dennis Ritchie"},"targetAlias":{"type":"string","example":"Ken Thompson"},"type":{"type":"string","enum":["CALL","VOICEMAIL","SMS","FAX"]},"created":{"type":"string","example":"2016-02-10T14:19:39Z"},"lastModified":{"type":"string","example":"2016-02-10T14:19:39Z"},"direction":{"type":"string","enum":["MISSED_INCOMING","INCOMING","OUTGOING","MISSED_OUTGOING"]}}},"HistoryResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/HistoryEntryResponse"}}}},"IdentityVerificationResponse":{"type":"object","properties":{"state":{"type":"string","enum":["SUCCESS","PENDING","FAILED"]},"externalReferenceId":{"type":"string"},"externalTransactionNumber":{"type":"string"},"externalVerificationLink":{"type":"string"}}},"ImportCSVRequest":{"type":"object","properties":{"base64Content":{"type":"string","example":"Zmlyc3RuYW1lLGxhc3RuYW1lLG51bWJlcgpBZGEsTG92ZWxhY2UsKzQ5MTU3OTk5MTIzNDUKQWxhbixUdXJpbmcsKzQ5MTU3OTk5MTIzNDUK"}}},"ImportGoogleRequest":{"type":"object","properties":{"token":{"type":"string"}}},"InitiateNewCallSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string"}}},"InternalContactResponse":{"type":"object","properties":{"id":{"type":"string","example":"0a50261ebd1a390fed2bf326f2673c145582a63"},"name":{"type":"string","example":"Ada Lovelace"},"emails":{"type":"array","items":{"type":"string"}},"mobile":{"type":"array","items":{"type":"string"}},"landline":{"type":"array","items":{"type":"string"}},"fax":{"type":"array","items":{"type":"string"}},"directdial":{"type":"array","items":{"type":"string"}}}},"InternalContactsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalContactResponse"}}}},"LinksResponse":{"type":"object","properties":{"accountsUrl":{"type":"string"},"accountTopUpUrl":{"type":"string"},"adminGroupsUrl":{"type":"string"},"adminIvrSettings":{"type":"string"},"adminProductSettingsUrl":{"type":"string"},"adminPublicPhonesUrl":{"type":"string"},"adminUsersUrl":{"type":"string"},"affiliateUrl":{"type":"string"},"appsUrl":{"type":"string"},"basicUrl":{"type":"string"},"bookConnectionUrl":{"type":"string"},"bookFaxlineUrl":{"type":"string"},"bookPhonelineUrl":{"type":"string"},"bookPhonenumberUrl":{"type":"string"},"conferenceUrl":{"type":"string"},"contactsUrl":{"type":"string"},"dashboardUrl":{"type":"string"},"faxAppUrl":{"type":"string"},"faxRescueUrl":{"type":"string"},"featureStoreUrl":{"type":"string"},"feedbackFormUrl":{"type":"string"},"forwardingsUrl":{"type":"string"},"helpdeskPhoneConfigurationUrl":{"type":"string"},"helpdeskUrl":{"type":"string"},"legacyTokenAuthenticateUrl":{"type":"string"},"loginUrl":{"type":"string"},"logoutUrl":{"type":"string"},"notificationsUrl":{"type":"string"},"personalSettingsUrl":{"type":"string"},"phonestatsUrl":{"type":"string"},"rescueUrl":{"type":"string"},"simquadratUrl":{"type":"string"},"startUpPageUrl":{"type":"string"},"supportUrl":{"type":"string"},"teamUrl":{"type":"string"},"tokenAuthenticateUrl":{"type":"string"},"trunkingUrl":{"type":"string"},"userSettingsUrl":{"type":"string"},"mnpFaqUrl":{"type":"string"},"sendFaxUrl":{"type":"string"}}},"LocalprefixRequest":{"type":"object","properties":{"value":{"type":"string","example":"030"},"active":{"type":"boolean","default":false}}},"LocalprefixResponse":{"type":"object","properties":{"value":{"type":"string","example":"0221"},"active":{"type":"boolean","default":false}}},"MobileCredentialsResponse":{"type":"object","properties":{"simId":{"type":"string","example":"1234567"},"puk1":{"type":"string","example":"12345"},"puk2":{"type":"string","example":"67890"}}},"MobileDeviceResponse":{"type":"object","properties":{"id":{"type":"string","example":"e0"},"alias":{"type":"string","example":"VoIP phone of Grace Hopper"},"type":{"type":"string","enum":["REGISTER","MOBILE","EXTERNAL"]},"online":{"type":"boolean","default":false},"dnd":{"type":"boolean","default":false},"activePhonelines":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"activeGroups":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"credentials":{"$ref":"#/definitions/MobileCredentialsResponse"}}},"ModifyAddressRequest":{"type":"object","required":["city","countrycode","postcode"],"properties":{"countrycode":{"type":"string","example":"DE"},"state":{"type":"string","example":"NRW"},"postcode":{"type":"string","example":"40219"},"city":{"type":"string","example":"Düsseldorf"},"street":{"type":"string","example":"Gladbacher Str."},"number":{"type":"string","example":"74"},"address1":{"type":"string","example":"1-3 Spring Gardens"},"address2":{"type":"string","example":"Flat A"}}},"NewCallRequest":{"type":"object","required":["callee","caller","deviceId"],"properties":{"deviceId":{"type":"string","example":"p0"},"caller":{"type":"string","example":"e0"},"callee":{"type":"string","example":"+4915799912345"},"callerId":{"type":"string","example":"+4915799912345"}}},"NotificationsResponse":{"type":"object","properties":{"fax":{"type":"array","items":{"$ref":"#/definitions/FaxNotificationResponse"}},"voicemail":{"type":"array","items":{"$ref":"#/definitions/VoicemailNotificationResponse"}},"call":{"type":"array","items":{"$ref":"#/definitions/CallNotificationResponse"}},"sms":{"type":"array","items":{"$ref":"#/definitions/SmsNotificationResponse"}}}},"Number":{"type":"object"},"NumberResponse":{"type":"object","properties":{"number":{"type":"string","example":"+4915799912345"},"type":{"type":"array","items":{"type":"string"}}}},"NumberResponseWithEndpoint":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string","example":"+4915799912345"},"localized":{"type":"string","example":"01579-9912345"},"type":{"type":"string","enum":["MOBILE","LANDLINE","QUICKDIAL","INTERNATIONAL"]},"endpointId":{"type":"string","example":"p0"},"endpointAlias":{"type":"string"},"endpointUrl":{"type":"string"}}},"NumbersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/NumberResponseWithEndpoint"}}}},"OAuthClient":{"type":"object","required":["clientId","clientSecret","description","name","redirectUris","webOrigins"],"properties":{"clientId":{"type":"string","example":"ABCDEF0123456789","description":"The unique OAuth 2.0 client identifier"},"clientSecret":{"type":"string","example":"ABCDEF0123456789","description":"The OAuth 2.0 client secret"},"name":{"type":"string","example":"Example name","description":"Name of the application the client is intended to use with"},"description":{"type":"string","example":"Example description","description":"Short description of the application the client is intended to use with"},"redirectUris":{"type":"array","example":["http://*.example.com/*","https://*.example.com/*"],"description":"Valid URI pattern a browser can redirect to after a successful login or logout (simple wildcards are allowed e.g. 'http://example.com/*')","items":{"type":"string"}},"webOrigins":{"type":"array","example":["http://*.example.com","https://*.example.com"],"description":"Allowed CORS origins (simple wildcards are allowed e.g. 'http://*.example.com')","items":{"type":"string"}}},"title":"OAuthClient"},"OAuthClients":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/OAuthClient"}}},"title":"OAuthClients"},"OrderSimRequest":{"type":"object","required":["addressId"],"properties":{"addressId":{"type":"string","example":"123456"}}},"ParallelForwardingResponse":{"type":"object","properties":{"id":{"type":"string","example":"x0"},"alias":{"type":"string","example":"Bjarne Stroustrup's mobile"},"destination":{"type":"string","example":"+4915799912345"},"active":{"type":"boolean","default":false}}},"ParallelForwardingsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ParallelForwardingResponse"}}}},"Participant":{"type":"object","required":["hold","muted","owner","participantId","phoneNumber"],"properties":{"participantId":{"type":"string","example":"ABCDEF0123456789","description":"The unique participant identifier"},"phoneNumber":{"type":"string","example":"+4915799912345","description":"Participants phone number (can be empty for various reasons, e.g. anonymous participant)"},"muted":{"type":"boolean","example":"false","description":"Participant is muted","default":false},"hold":{"type":"boolean","example":"false","description":"Participant is on hold","default":false},"owner":{"type":"boolean","example":"false","description":"Participant is the call owner","default":false}}},"PhonelineBlockAnonymousResponse":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"target":{"type":"string","enum":["REJECT","VOICEMAIL"]}}},"PhonelineBusyOnBusyResponse":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"PhonelineResponse":{"type":"object","properties":{"id":{"type":"string","example":"p0"},"alias":{"type":"string","example":"Alan Turing"},"blockAnonymousUrl":{"type":"string"},"busyOnBusyUrl":{"type":"string"},"devicesUrl":{"type":"string"},"forwardingsUrl":{"type":"string"},"numbersUrl":{"type":"string"},"parallelForwardingsUrl":{"type":"string"},"voicemailsUrl":{"type":"string"}}},"PhonelineSipgateIoLogResponse":{"type":"object","properties":{"created":{"type":"string","example":"2015-10-21T19:28:00Z"},"url":{"type":"string","example":"https://demo.sipgate.io"},"request":{"type":"string","example":"event=newCall&from=492111234567&to=4915791234567&direction=in&callId=123456&user[]=Alice"},"response":{"type":"string","example":"HTTP/1.1 200 OK..."},"xmlError":{"type":"string","example":"Response does not have content type application/xml"},"status":{"type":"string","example":"200"}}},"PhonelineSipgateIoLogsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PhonelineSipgateIoLogResponse"}}}},"PhonelineSipgateIoResponse":{"type":"object","properties":{"incomingActive":{"type":"boolean","default":false},"outgoingActive":{"type":"boolean","default":false},"incomingUrl":{"type":"string","example":"https://io.sipgate.beer/my/incoming/url"},"outgoingUrl":{"type":"string","example":"https://io.sipgate.rehab/my/outgoing/url"},"log":{"type":"boolean","default":false},"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----"},"allowSelfSigned":{"type":"boolean","default":false}}},"PhonelinesResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PhonelineResponse"}}}},"PortingNumberResponse":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string","example":"+4915799912345"}}},"PortingResponse":{"type":"object","properties":{"id":{"type":"string"},"portDate":{"type":"string","example":"2015-10-21"},"numbers":{"type":"array","items":{"$ref":"#/definitions/PortingNumberResponse"}},"status":{"type":"integer","format":"int32","example":200},"revocable":{"type":"boolean","default":false},"pending":{"type":"boolean","default":false}}},"PortingsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PortingResponse"}}}},"PropertiesResponse":{"type":"object","properties":{"identityVerificationRequired":{"type":"boolean","default":false},"welcomeScreenEnabled":{"type":"boolean","default":false}}},"RecordingRequest":{"type":"object","required":["announcement","value"],"properties":{"announcement":{"type":"boolean","example":"true","description":"Announce recording start/stop to all participants","default":false},"value":{"type":"boolean","example":"true","description":"Start/stop the recording","default":false}}},"RegisterDeviceResponse":{"type":"object","properties":{"id":{"type":"string","example":"e0"},"alias":{"type":"string","example":"VoIP phone of Grace Hopper"},"type":{"type":"string","enum":["REGISTER","MOBILE","EXTERNAL"]},"online":{"type":"boolean","default":false},"dnd":{"type":"boolean","default":false},"activePhonelines":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"activeGroups":{"type":"array","items":{"$ref":"#/definitions/ActiveRouting"}},"credentials":{"$ref":"#/definitions/CredentialsResponse"},"registered":{"type":"array","items":{"$ref":"#/definitions/RegisteredDevice"}},"emergencyAddressId":{"type":"string","example":"1234"},"addressUrl":{"type":"string","example":"/addresses/1234"}}},"RegisteredDevice":{"type":"object","properties":{"userAgent":{"type":"string"},"ip":{"type":"string"},"port":{"type":"string"}}},"ReportTarget":{"type":"object","properties":{"id":{"type":"string","example":"42"},"email":{"type":"string","example":"grace.hopper@example.com"}}},"RequestPasswordResetRequest":{"type":"object","properties":{"username":{"type":"string"}}},"ResendFaxRequest":{"type":"object","required":["faxId","faxlineId"],"properties":{"faxId":{"type":"string","example":"100018428"},"faxlineId":{"type":"string","example":"f0"}}},"RestrictionItem":{"type":"object","properties":{"restriction":{"type":"string","enum":["CAN_CREATE_REGISTER_DEVICE","CAN_DELETE_REGISTER_DEVICE","CAN_CREATE_MOBILE_DEVICE","CAN_DELETE_MOBILE_DEVICE","CAN_CREATE_EXTERNAL_DEVICE","CAN_DELETE_EXTERNAL_DEVICE","CAN_CHANGE_EXTERNAL_DEVICE","CAN_BOOK_PHONELINE_FEATURE","CAN_CREATE_PHONELINE_EXTENSION","CAN_DELETE_PHONELINE_EXTENSION","CAN_CREATE_QUICKDIAL_NUMBER","CAN_CHANGE_QUICKDIAL_NUMBER","CAN_DELETE_QUICKDIAL_NUMBER","CAN_GET_HISTORY","CAN_DELETE_HISTORY","CAN_CREATE_FAX_EXTENSION","CAN_DELETE_FAX_EXTENSION","CAN_BOOK_FAX_FEATURE","CAN_SEND_FAX","CAN_RECEIVE_FAX","CAN_CHANGE_DEVICE_EMERGENCY_LOCATION","CAN_ACTIVATE_SIM","MAX_PARALLEL_FORWARDINGS","MAX_FORWARDINGS","NOTIFICATION_RESTRICTIONS","GSUITE_EXTENSION"]},"value":{"type":"object"},"target":{"type":"string","example":"w0"}}},"RouteDeviceRequest":{"type":"object","required":["deviceId"],"properties":{"deviceId":{"type":"string","example":"e0"}}},"SendFaxRequest":{"type":"object","required":["base64Content","faxlineId","filename","recipient"],"properties":{"faxlineId":{"type":"string","example":"f0"},"recipient":{"type":"string","example":"+4921112345678"},"filename":{"type":"string","example":"fax.pdf"},"base64Content":{"type":"string","example":"TWF5IHRoZSBmb3VydGggYmUgd2l0aCB5b3U=","minLength":0,"maxLength":28330000}}},"SendFaxSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string"}}},"SendWebSmsRequest":{"type":"object","required":["message","recipient","smsId"],"properties":{"smsId":{"type":"string","example":"s0"},"recipient":{"type":"string","example":"+4915799912345"},"message":{"type":"string","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."}}},"SetAliasRequest":{"type":"object","properties":{"alias":{"type":"string","example":"Theodore Sturgeon's connection"}}},"SetBlockAnonymousSettingsRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"target":{"type":"string","enum":["REJECT","VOICEMAIL"]}}},"SetBusyOnBusySettingsRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"SetDefaultDeviceRequest":{"type":"object","required":["deviceId"],"properties":{"deviceId":{"type":"string","example":"e0"}}},"SetDeviceAliasRequest":{"type":"object","properties":{"value":{"type":"string","example":"Theodore Sturgeon's device"}}},"SetForwardingsRequest":{"type":"object","properties":{"forwardings":{"type":"array","items":{"$ref":"#/definitions/Forwarding"},"maxItems":3,"minItems":0}}},"SetParallelForwardingRequest":{"type":"object","properties":{"destination":{"type":"string","example":"+4915799912345"},"alias":{"type":"string","example":"Bjarne Stroustrup's mobile"},"active":{"type":"boolean","default":false}}},"SetSipgateIoAccountSettingsRequest":{"type":"object","required":["incomingUrl","outgoingUrl"],"properties":{"incomingUrl":{"type":"string","example":"https://io.sipgate.beer/my/incoming/url"},"outgoingUrl":{"type":"string","example":"https://io.sipgate.rehab/my/outgoing/url"}}},"SetSipgateIoPhonelineSettingsRequest":{"type":"object","required":["incomingUrl","outgoingUrl"],"properties":{"incomingActive":{"type":"boolean","default":false},"outgoingActive":{"type":"boolean","default":false},"incomingUrl":{"type":"string","example":"https://io.sipgate.beer/my/incoming/url"},"outgoingUrl":{"type":"string","example":"https://io.sipgate.rehab/my/outgoing/url"},"log":{"type":"boolean","default":false},"certificate":{"type":"string","example":"-----BEGIN CERTIFICATE-----"},"allowSelfSigned":{"type":"boolean","default":false}}},"SetSmsCallerIdRequest":{"type":"object","properties":{"defaultNumber":{"type":"boolean","default":false}}},"SingleRowDisplayRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"SingleRowDisplayResponse":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"SipgateIoUrlResponse":{"type":"object","properties":{"incomingUrl":{"type":"string","example":"https://io.sipgate.beer/my/incoming/url"},"outgoingUrl":{"type":"string","example":"https://io.sipgate.rehab/my/outgoing/url"}}},"SmsCallerIdRequest":{"type":"object","properties":{"phonenumber":{"type":"string","example":"+4915799912345"}}},"SmsCallerIdResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"phonenumber":{"type":"string"},"verified":{"type":"boolean","default":false},"defaultNumber":{"type":"boolean","default":false}}},"SmsCallerIdsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/SmsCallerIdResponse"}}}},"SmsEmailTarget":{"type":"object","properties":{"id":{"type":"string","example":"42"},"email":{"type":"string","example":"grace.hopper@example.com"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]}}},"SmsExtensionResponse":{"type":"object","properties":{"id":{"type":"string","example":"s0"},"alias":{"type":"string","example":"SMS von Douglas Engelbart"},"callerId":{"type":"string","example":"+4915799912345"}}},"SmsExtensionsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/SmsExtensionResponse"}}}},"SmsNotificationResponse":{"type":"object","properties":{"endpointId":{"type":"string","example":"f0/v0/p0"},"endpointAlias":{"type":"string","example":"Fax/Voicemail of Grace Hopper"},"emails":{"type":"array","items":{"$ref":"#/definitions/SmsEmailTarget"}}}},"SmsTarget":{"type":"object","properties":{"id":{"type":"string","example":"1337"},"number":{"type":"string","example":"+4915799912345"}}},"TacRequest":{"type":"object","properties":{"accepted":{"type":"boolean","default":false}}},"TacResponse":{"type":"object","properties":{"accepted":{"type":"boolean","default":false}}},"TariffAnnouncementRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"TariffAnnouncementResponse":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"TokenCreateResponse":{"type":"object","properties":{"token":{"type":"string"}}},"TransferRequest":{"type":"object","required":["attended","phoneNumber"],"properties":{"attended":{"type":"boolean","example":"false","description":"The transfer is attended or blind","default":false},"phoneNumber":{"type":"string","example":"+4915799912345","description":"Transfer target phone number"}}},"UserResponse":{"type":"object","properties":{"id":{"type":"string","example":"w0"},"firstname":{"type":"string","example":"Ada"},"lastname":{"type":"string","example":"Lovelace"},"email":{"type":"string","example":"ada.lovelace@sipgate.love"},"defaultDevice":{"type":"string","example":"e0"},"admin":{"type":"boolean","default":false}}},"UserinfoResponse":{"type":"object","properties":{"sub":{"type":"string","example":"w0"},"domain":{"type":"string","example":"sipgate.de"},"masterSipId":{"type":"string","example":"0000000"},"locale":{"type":"string","example":"de_DE"}}},"UsersResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/UserResponse"}}}},"VerifySmsCallerIdRequest":{"type":"object","properties":{"verificationCode":{"type":"string"}}},"VoicemailNotificationResponse":{"type":"object","properties":{"endpointId":{"type":"string","example":"f0/v0/p0"},"endpointAlias":{"type":"string","example":"Fax/Voicemail of Grace Hopper"},"emails":{"type":"array","items":{"$ref":"#/definitions/EmailTarget"}},"sms":{"type":"array","items":{"$ref":"#/definitions/SmsTarget"}}}},"VoicemailResponse":{"type":"object","properties":{"id":{"type":"string","example":"v0"},"alias":{"type":"string","example":"Voicemail of Grace Hopper"},"timeout":{"type":"integer","format":"int32","example":20},"active":{"type":"boolean","default":false},"transcription":{"type":"boolean","default":false},"canTranscribe":{"type":"boolean","default":false},"greetingsUrl":{"type":"string"},"activeGreetingAlias":{"type":"string"},"activeGreetingId":{"type":"string"},"accessNumber":{"type":"string","example":"50000"}}},"VoicemailsResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/VoicemailResponse"}}}},"WelcomeRequest":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}},"securityDefinitions":{"oauth2":{"authorizationUrl":"https://api.sipgate.com/login/third-party/protocol/openid-connect/auth","flow":"implicit","scopes":{"settings:sipgateio:read":"Access global webhooks","addresses:write":"Manage addresses","faxlines:numbers:read":"Access fax device settings (numbers)","devices:callerid:write":"Manage caller ID","phonelines:parallelforwardings:read":"Access parallel forwarding settings","sessions:sms:write":"Send SMS","users:read":"Access users","devices:read":"Access device settings","phonelines:forwardings:write":"Manage call forwarding settings","numbers:read":"Access phone numbers","phonelines:blockanonymous:read":"Access anonymous call settings","notifications:read":"Access notifications","authorization:oauth2:clients:write":"Manage OAuth 2.0 clients","phonelines:voicemails:greetings:read":"Access connection voicemail announcement settings","groups:devices:write":"Manage group device settings","rtcm:write":"Manage active calls","all":"Full access","phonelines:devices:write":"Manage connection devices","phonelines:read":"Access connections","addresses:read":"Access addresses","groups:users:read":"Access group members","sms:callerid:read":"Access SMS caller ID","openid":"User information","settings:sipgateio:write":"Manage global webhooks","devices:localprefix:write":"Manage automatic local area code","faxlines:write":"Manage fax device settings","phonelines:sipgateio:write":"Manage webhooks","portings:read":"Access number ports","groups:voicemails:read":"Access group voicemail settings","phonelines:parallelforwardings:write":"Manage parallel forwarding settings","notifications:write":"Manage notifications","users:defaultdevice:write":"Manage default device settings","authorization:oauth:clients:write":"Manage OAuth clients","phonelines:forwardings:read":"Access call forwarding settings","sms:write":"Manage SMS device settings","push_device:register":"Manage push notifications","devices:sim:read":"Access SIM settings","phonelines:blockanonymous:write":"Manage anonymous call settings","history:read":"Access call history","account:read":"Access account details","internal":"sipgate internal","devices:singlerowdisplay:read":"Access hide own number settings","sms:read":"Access SMS device settings","devices:write":"Manage device settings","numbers:write":"Manage phone numbers","authorization:oauth:clients:read":"Access OAuth clients","devices:localprefix:read":"Access automatic local area code","devices:sims:orders:write":"Order SIM cards","phonelines:busyonbusy:write":"Manage busy on busy settings","sessions:write":"Initiate calls, send faxes, send SMS","groups:numbers:read":"Access group numbers","rtcm:read":"Access active calls","groups:read":"Access groups","devices:tariffannouncement:write":"Manage rate announcement settings","authorization:oauth2:clients:read":"Access OAuth 2.0 clients","phonelines:sipgateio:read":"Access webhooks","devices:sim:write":"Manage SIM settings","history:write":"Manage call history","phonelines:sipgateio:log:read":"Access webhook debug log","account:write":"Manage account details","sms:callerid:write":"Manage SMS caller ID","phonelines:devices:read":"Access connection devices","balance:read":"Access account balance","groups:faxlines:read":"Access group fax device settings","contacts:read":"Access contacts","portings:write":"Manage number ports","phonelines:voicemails:greetings:write":"Manage connection voicemail announcement settings","devices:tariffannouncement:read":"Access rate announcement settings","sessions:calls:write":"Initiate calls","faxlines:read":"Access fax device settings","settings:write":"Manage global account settings","phonelines:write":"Manage connections","phonelines:numbers:read":"Access connection numbers","devices:callerid:read":"Access caller ID","devices:singlerowdisplay:write":"Manage hide own number settings","phonelines:voicemails:read":"Access connection voicemail settings","phonelines:voicemails:write":"Manage connection voicemail settings","sessions:fax:write":"Send faxes","phonelines:busyonbusy:read":"Access busy on busy settings","contacts:write":"Manage contacts","settings:read":"Access global account settings"},"tokenUrl":"https://api.sipgate.com/login/third-party/protocol/openid-connect/token","type":"oauth2"}},"tags":[{"name":"account"},{"name":"addresses"},{"name":"app"},{"name":"authorization"},{"name":"balance"},{"name":"contacts"},{"name":"devices"},{"name":"faxlines"},{"name":"groupfaxlines"},{"name":"groups"},{"name":"history"},{"name":"identityVerification"},{"name":"internal contacts"},{"name":"notifications"},{"name":"numbers"},{"name":"password reset"},{"name":"phonelines"},{"name":"portings"},{"name":"restrictions"},{"name":"rtcm"},{"name":"sessions"},{"name":"settings"},{"name":"sms"},{"name":"translations"},{"name":"urls"},{"name":"users"}]}