{"info":{"title":"RingCentral Connect Platform API","description":"This is an interactive API explorer for the RingCentral Connect Platform. To use this service, you will need to have a developer account.\n\n## Links\n* RingCentral API Spec  (OpenAPI fka Swagger format)    Learn more about OpenAPI\n","version":"1.0.46"},"tags":[{"name":"API Info"},{"name":"SMS and MMS"},{"name":"Fax"},{"name":"Internal Messages"},{"name":"Voicemail"},{"name":"Message Store Configuration"},{"name":"ADG"},{"name":"Presence"},{"name":"Subscriptions"},{"name":"Application Settings"},{"name":"Devices"},{"name":"SCIM"},{"name":"Verification Call","description":" "},{"name":"Call Control"},{"name":"RDG"}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://example.com/api/oauth/dialog","tokenUrl":"https://platform.ringcentral.com/restapi/oauth/token","scopes":{"scope":"scope description"}}}},"api_key":{"type":"apiKey","name":"api_key","in":"header"}},"schemas":{"GetVersionsResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the API version"},"apiVersions":{"type":"array","description":"Full API version information: uri, number, release date","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of API versions"},"versionString":{"type":"string","description":"Version of the RingCentral REST API"},"releaseDate":{"type":"string","description":"Release date of this version"},"uriString":{"type":"string","description":"URI part determining the current version"}}}},"serverVersion":{"type":"string","description":"Server version"},"serverRevision":{"type":"string","description":"Server revision"}},"example":{"application/json":{"uri":"https://platform.ringcentral.com/restapi","apiVersions":[{"uri":"https://platform.ringcentral.com/restapi/v1.0","versionString":"1.0.34","releaseDate":"2018-02-09T00:00:00.000Z","uriString":"v1.0"}],"serverVersion":"10.0.4.7854","serverRevision":"32f2a96b769c"}}},"GetVersionResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the version info resource"},"versionString":{"type":"string","description":"Version of the RingCentral REST API"},"releaseDate":{"type":"string","description":"Release date of this version"},"uriString":{"type":"string","description":"URI part determining the current version"}},"example":{"application/json":{"uri":"https://platform.ringcentral.com/restapi/v1.0","versionString":"1.0.34","releaseDate":"2018-02-09T00:00:00.000Z","uriString":"v1.0"}}},"VersionInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of API versions"},"versionString":{"type":"string","description":"Version of the RingCentral REST API"},"releaseDate":{"type":"string","description":"Release date of this version"},"uriString":{"type":"string","description":"URI part determining the current version"}}},"AccountCallLogResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of company call log records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"AccountCallLogSyncResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Link to account call log sync resource"},"records":{"type":"array","description":"List of call log records with synchronization information. For 'ISync' the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Time of last synchronization in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*"}},"description":"Sync information (type, token and time)"}}},"CompanyCallLogRecord":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}},"CompanyActiveCallsResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of company active call records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallLogSync":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of call log records with sync information"},"records":{"type":"array","description":"List of call log records with synchronization information. For ISync the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"The last synchronization datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}},"description":"Sync information (type, token and time)"}}},"UserCallLogRecord":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}},"UserActiveCallsResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of user active call records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"GetCallRecordingResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call recording"},"contentUri":{"type":"string","description":"Link to a call recording binary content"},"contentType":{"type":"string","description":"Call recording file format. Supported format is audio/x-wav"},"duration":{"type":"integer","description":"Recorded call duration"}}},"UserCallLogResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"SyncInfoCallLog":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"The last synchronization datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}},"description":"Sync information (type, token and time)"},"CallLogNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"BillingInfo":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"CallLogRecordMessage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"CallLogRecordingInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"ActiveCallsRecordExtensionInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension on whose behalf a call is initiated"},"id":{"type":"string","description":"Internal identifier of an extension on whose behalf a call is initiated"}},"description":"Information about extension on whose behalf a call is initiated. For Secretary call log the Boss extension info is returned"},"CompanyCallLogSyncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Time of last synchronization in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*"}},"description":"Sync information (type, token and time)"},"CallLogPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"DelegateInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"CallLogCallerInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"ExtensionInfoCallLog":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"CallLogRecordLegInfo":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}},"CallLogRecordDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}},"CallLogNavigationInfoURI":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"GetMessageList":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of user messages"},"records":{"type":"array","description":"List of records with message information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"InstantMessageEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message. The default value is 'SMS'"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound"},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Deprecated. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"UpdateMessageRequest":{"type":"object","properties":{"readStatus":{"type":"string","description":"Read status of a message to be changed. Multiple values are accepted","enum":["Read","Unread"]}}},"CreateInternalTextMessageRequest":{"required":["text"],"type":"object","properties":{"from":{"type":"object","properties":{"extensionId":{"type":"string","description":"Extension identifier","example":"123456789"},"extensionNumber":{"type":"string","description":"Extension number","example":"105"}},"description":"Sender of a pager message."},"replyOn":{"type":"integer","description":"Internal identifier of a message this message replies to"},"text":{"type":"string","description":"Text of a pager message. Max length is 1024 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 512 symbols","example":"hello world"},"to":{"type":"array","description":"Optional if replyOn parameter is specified. Receiver of a pager message.","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Extension identifier","example":"123456789"},"extensionNumber":{"type":"string","description":"Extension number","example":"105"}},"description":"Sender of a pager message."}}}},"GetInternalTextMessageInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation that the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}},"FaxResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message","format":"int64"},"uri":{"type":"string","description":"Canonical URI of a message"},"type":{"type":"string","description":"Message type - 'Fax'"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"description":"Sender information"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"},"messageStatus":{"type":"string","enum":["Sent","SendingFailed","Queued"]},"faxErrorCode":{"type":"string","enum":["Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]}}}},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment","format":"int64"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Voicemail only Duration of the voicemail in seconds"},"filename":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"}}}},"direction":{"type":"string","description":"Message direction","enum":["Inbound","Outbound"]},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"messageStatus":{"type":"string","description":"Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default)","enum":["Queued","Sent","SendingFailed","Received"]},"faxResolution":{"type":"string","description":"Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)","enum":["High","Low"]},"faxPageCount":{"type":"integer","description":"Page count in a fax message"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}},"VoicemailMessageEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"},"body":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message","enum":["Voicemail"]},"creationTime":{"type":"string","description":"Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","description":"Message priority","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound","enum":["Inbound","Outbound"]},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Internal identifier of a conversation this message belongs to"},"vmTranscriptionStatus":{"type":"string","description":"Specifies if a voicemail message transcription is already completed or not"}},"description":"Notification payload body"}}},"CreateSMSMessage":{"required":["from","text","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}}}},"CreateMMSMessage":{"required":["attachments","from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}},"attachments":{"type":"array","description":"Media file(s) to upload","items":{"type":"string","format":"binary"}}}},"GetMessageSyncResponse":{"required":["records","syncInfo"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the message sync resource"},"records":{"type":"array","description":"List of message records with synchronization information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}},"description":"Sync type, token and time"}}},"GetSMSMessageInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation that the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}},"GetMessageInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}},"InboundMessageEvent":{"type":"object","properties":{"aps":{"type":"object","properties":{"alert":{"type":"object","properties":{"title":{"type":"string","description":"Title of a message"},"body":{"type":"string","description":"Message Description"}},"description":"Alert information"},"badge":{"type":"string","description":"Number of incoming messages"},"sound":{"type":"string","description":"Message sound"},"content-available":{"type":"string","description":"Content availability"},"category":{"type":"string","description":"Category of a message"}},"description":"Information on a notification"},"messageId":{"type":"string","description":"Internal identifier of a message"},"conversationId":{"type":"string","description":"Internal identifier of a conversation"},"from":{"type":"string","description":"Sender phone number. For GCM transport type '_from' property should be used"},"to":{"type":"string","description":"Receiver phone number"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}},"GetMessageMultiResponse":{"type":"array","items":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of a resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a message"},"id":{"type":"string","description":"Internal identifier of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed"]}}}}}},"MessageStoreConfiguration":{"type":"object","properties":{"retentionPeriod":{"maximum":90,"minimum":7,"type":"integer","description":"Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days"}}},"ListFaxCoverPagesResponse":{"type":"object","properties":{"uri":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a fax cover page. The possible value range is 0-13 (for language setting en-US) and 0, 15-28 (for all other languages)"},"name":{"type":"string","description":"Name of a fax cover page pattern"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"MessageEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"lastUpdated":{"type":"string","description":"Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"changes":{"type":"array","description":"Message Changes","items":{"type":"object","properties":{"type":{"type":"string","description":"Message type","enum":["Voicemail","SMS","Fax","Pager"]},"newCount":{"type":"integer","description":"The number of new messages. Can be omitted if the value is zero"},"updatedCount":{"type":"integer","description":"The number of updated messages. Can be omitted if the value is zero"}}}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"MessageSenderInfo":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"CallerInfoFrom":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"description":"Sender information"},"NotificationInfo":{"type":"object","properties":{"alert":{"type":"object","properties":{"title":{"type":"string","description":"Title of a message"},"body":{"type":"string","description":"Message Description"}},"description":"Alert information"},"badge":{"type":"string","description":"Number of incoming messages"},"sound":{"type":"string","description":"Message sound"},"content-available":{"type":"string","description":"Content availability"},"category":{"type":"string","description":"Category of a message"}},"description":"Information on a notification"},"MessageAttachmentInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}},"AlertInfo":{"type":"object","properties":{"title":{"type":"string","description":"Title of a message"},"body":{"type":"string","description":"Message Description"}},"description":"Alert information"},"MessageStoreCallerInfoResponseTo":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}},"MessageStoreCallerInfoResponseFrom":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"MessageBody":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a message"},"id":{"type":"string","description":"Internal identifier of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed"]}}},"MessageStoreCallerInfoRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"VoicemailMessageEventBody":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message","enum":["Voicemail"]},"creationTime":{"type":"string","description":"Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","description":"Message priority","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound","enum":["Inbound","Outbound"]},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Internal identifier of a conversation this message belongs to"},"vmTranscriptionStatus":{"type":"string","description":"Specifies if a voicemail message transcription is already completed or not"}},"description":"Notification payload body"},"ConversationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"MessageChanges":{"type":"object","properties":{"type":{"type":"string","description":"Message type","enum":["Voicemail","SMS","Fax","Pager"]},"newCount":{"type":"integer","description":"The number of new messages. Can be omitted if the value is zero"},"updatedCount":{"type":"integer","description":"The number of updated messages. Can be omitted if the value is zero"}}},"CreateVoicemailToInfo":{"required":["extensionId"],"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"}}},"FaxMessageAttachment":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"filename":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"}}},"InstantMessageEventBody":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message. The default value is 'SMS'"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound"},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Deprecated. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"GetCompanyPagerMessageInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}},"NotificationRecipientInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}},"SenderInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"MessageEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"lastUpdated":{"type":"string","description":"Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"changes":{"type":"array","description":"Message Changes","items":{"type":"object","properties":{"type":{"type":"string","description":"Message type","enum":["Voicemail","SMS","Fax","Pager"]},"newCount":{"type":"integer","description":"The number of new messages. Can be omitted if the value is zero"},"updatedCount":{"type":"integer","description":"The number of updated messages. Can be omitted if the value is zero"}}}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"FaxCoverPageInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a fax cover page. The possible value range is 0-13 (for language setting en-US) and 0, 15-28 (for all other languages)"},"name":{"type":"string","description":"Name of a fax cover page pattern"}}},"MessagingPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"CallerInfoTo":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"},"messageStatus":{"type":"string","enum":["Sent","SendingFailed","Queued"]},"faxErrorCode":{"type":"string","enum":["Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]}}},"MessagingNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"MessageCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}},"MessageRecipientInfo":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}},"PagerCallerInfoRequest":{"type":"object","properties":{"extensionId":{"type":"string","description":"Extension identifier","example":"123456789"},"extensionNumber":{"type":"string","description":"Extension number","example":"105"}},"description":"Sender of a pager message."},"MessageAttachmentInfoIntId":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment","format":"int64"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Voicemail only Duration of the voicemail in seconds"},"filename":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"}}},"MessagingNavigationInfoURI":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"FaxMessageEventBody":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message","enum":["Fax"]},"creationTime":{"type":"string","description":"Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"filename":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound"},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Internal identifier of a conversation this message belongs to"},"faxResolution":{"type":"string","description":"Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)"},"faxPageCount":{"type":"integer","description":"Page count of a fax message"}},"description":"Notification payload body"},"GetMessageInfoMultiResponse":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of a resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a message"},"id":{"type":"string","description":"Internal identifier of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed"]}}}}},"SyncInfoMessages":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}},"description":"Sync type, token and time"},"MakeRingOutRequest":{"required":["from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"},"forwardingNumberId":{"type":"string","description":"Internal identifier of a forwarding number; returned in response as an 'id' field value. Can be specified instead of the phoneNumber attribute"}},"description":"Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of the user's configured forwarding numbers or an arbitrary number"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of the RingOut call"},"callerId":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"The number which will be displayed to the called party"},"playPrompt":{"type":"boolean","description":"The audio prompt that the calling party hears when the call is connected"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Dialing plan country identifier"}},"description":"Optional. Dialing plan country data. If not specified, then extension home country is applied by default"}}},"GetRingOutStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a RingOut call"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}},"GetRingOutStatusResponseIntId":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a RingOut call","format":"int64"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}},"GreetingRecordingCallForwardingNumber":{"type":"object","properties":{"id":{"type":"string"}}},"MakeRingOutCallerInfoRequestFrom":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"},"forwardingNumberId":{"type":"string","description":"Internal identifier of a forwarding number; returned in response as an 'id' field value. Can be specified instead of the phoneNumber attribute"}},"description":"Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of the user's configured forwarding numbers or an arbitrary number"},"MakeRingOutCallerInfoRequestTo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of the RingOut call"},"MakeRingOutCallerIdInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"The number which will be displayed to the called party"},"MakeRingOutCoutryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Dialing plan country identifier"}},"description":"Optional. Dialing plan country data. If not specified, then extension home country is applied by default"},"RingOutStatusInfo":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"},"GreetingRecordingCallAnsweringRule":{"type":"object","properties":{"id":{"type":"string"}}},"ExtensionFavoritesEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"FavoriteCollection":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}}}}},"PersonalContactRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}},"PersonalContactResource":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}},"ContactList":{"type":"object","properties":{"uri":{"type":"string","description":"link to the list of user personal contacts"},"records":{"type":"array","description":"List of personal contacts from the extension address book","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"groups":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of address book groups"}},"description":"Information on address book groups"}}},"AddressBookSync":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","enum":["FSync","ISync"]},"syncToken":{"type":"string"},"syncTime":{"type":"string","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}}},"nextPageId":{"type":"integer","format":"int64"},"nextPageUri":{"type":"string","format":"uri"}}},"FavoriteContactList":{"type":"object","properties":{"uri":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}}}}},"UserContactsNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"UserContactsNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"UserContactsPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"UserContactsGroupsInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of address book groups"}},"description":"Information on address book groups"},"ContactAddressInfo":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"SyncInfo":{"type":"object","properties":{"syncType":{"type":"string","enum":["FSync","ISync"]},"syncToken":{"type":"string"},"syncTime":{"type":"string","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}}},"FavoriteContactResource":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}},"ExtensionFavoritesEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"SearchDirectoryEntriesRequest":{"type":"object","properties":{"searchString":{"type":"string","description":"String value to filter the contacts. The value specified is searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`, `jobTitle`, `department`"},"searchFields":{"type":"array","items":{"type":"string","enum":["firstName","lastName","extensionNumber","phoneNumber","email","jobTitle","department"]}},"showFederated":{"type":"boolean","description":"If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case","default":true},"extensionType":{"type":"string","description":"Type of extension to filter the contacts. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","IvrMenu","Limited","ApplicationExtension","Site","Bot","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"orderBy":{"type":"array","description":"Sorting settings","items":{"type":"object","properties":{"index":{"type":"integer","description":"Sorting priority index, starting from '1'. Optional if only one element in `orderBy` array is specified"},"fieldName":{"type":"string","description":"Field name by which to sort the contacts","enum":["firstName","lastName","extensionNumber","phoneNumber","email","jobTitle","department"]},"direction":{"type":"string","description":"Sorting direction","enum":["Asc","Desc"]}}}},"page":{"type":"integer"},"perPage":{"type":"integer"}}},"DirectoryResource":{"type":"object","properties":{"paging":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"records":{"type":"array","items":{"type":"object","properties":{"account":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"department":{"type":"string"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"id":{"type":"string"},"jobTitle":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}},"profileImage":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"status":{"type":"string"},"type":{"type":"string"}}}}}},"ErrorResponse":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"},"ContactResource":{"type":"object","properties":{"account":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"department":{"type":"string"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"id":{"type":"string"},"jobTitle":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}},"profileImage":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"status":{"type":"string"},"type":{"type":"string"}}},"FederationResource":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string"},"conflictCount":{"type":"integer","format":"int32"},"federatedName":{"type":"string"},"id":{"type":"string"},"linkCreationTime":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}}},"creationTime":{"type":"string"},"displayName":{"type":"string"},"id":{"type":"string"},"lastModifiedTime":{"type":"string"}}},"Health":{"type":"object","properties":{"last_changed":{"type":"integer","format":"int64"},"last_changed_str":{"type":"string"},"state":{"type":"string","enum":["GOOD","BAD","BLACKLIST_ME"]},"uptime":{"type":"string"}}},"UserResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of contact"},"status":{"type":"string","description":"Enabled | Disabled | Frozen | NotActivated"},"name":{"type":"string","description":"Full name"},"phoneNumbers":{"type":"array","description":"entries/phoneNumbers","items":{"type":"object","properties":{"e164":{"type":"string"},"formatted":{"type":"string"}}}},"extensionNumber":{"type":"string","description":"Extension number"},"role":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"department":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}}}}},"CompanyContactsPagingInfo":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"Checker":{"type":"object","properties":{"diagnostic":{"type":"string"},"last_state_changed":{"type":"integer","format":"int64"},"last_state_changed_str":{"type":"string"},"last_timestamp":{"type":"integer","format":"int64"},"last_timestamp_str":{"type":"string"},"state":{"type":"string","enum":["GOOD","FAIL","BLACKLIST_ME"]}}},"CompanyDirectoryPhoneNumberInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Extension phone number in E.164 format"},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"hidden":{"type":"boolean","description":"Specifies if a phone number should be hidden or not. Returned only if the value is 'True'"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber"]}},"description":"Extension phone number information"},"CompanyDirectoryProfileImageInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image resource"},"etag":{"type":"string","description":"Internal identifier of an image"}},"description":"Extension profile image information. Not returned if profile images are absent for an extension"},"ConflictExtensionResource":{"required":["id"],"type":"object","properties":{"id":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"conflicts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"account":{"type":"object","properties":{"federatedName":{"type":"string"},"id":{"type":"string"}}}}}}}},"FederatedAccountResource":{"type":"object","properties":{"companyName":{"type":"string"},"conflictCount":{"type":"integer","format":"int32"},"federatedName":{"type":"string"},"id":{"type":"string"},"linkCreationTime":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"OrderBy":{"type":"object","properties":{"index":{"type":"integer","description":"Sorting priority index, starting from '1'. Optional if only one element in `orderBy` array is specified"},"fieldName":{"type":"string","description":"Field name by which to sort the contacts","enum":["firstName","lastName","extensionNumber","phoneNumber","email","jobTitle","department"]},"direction":{"type":"string","description":"Sorting direction","enum":["Asc","Desc"]}}},"CompanyDirectoryEventBody":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of change"},"type":{"type":"string","description":"Type of extension"},"status":{"type":"string","description":"Status of an extension","enum":["Enabled","NotActivated","Disabled"]},"firstName":{"type":"string","description":"First name of a user extension"},"lastName":{"type":"string","description":"Last name of a user extension"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"department":{"type":"string","description":"Department name"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"account":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"}},"description":"Account data of an extension"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Extension phone number in E.164 format"},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"hidden":{"type":"boolean","description":"Specifies if a phone number should be hidden or not. Returned only if the value is 'True'"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber"]}},"description":"Extension phone number information"}},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a site"},"name":{"type":"string","description":"Custom name of a site"}},"description":"Site Data"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image resource"},"etag":{"type":"string","description":"Internal identifier of an image"}},"description":"Extension profile image information. Not returned if profile images are absent for an extension"}},"description":"Notification payload body"},"UserCustomFieldResource":{"type":"object","properties":{"id":{"type":"string"},"value":{"type":"string"}}},"AccountResource":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"Error":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"},"ConflictAccountInfo":{"type":"object","properties":{"federatedName":{"type":"string"},"id":{"type":"string"}}},"AccountDirectoryProfileImageResource":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"BusinessSiteResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"ExtensionFederationMembershipResource":{"type":"object","properties":{"id":{"type":"string"},"member":{"type":"boolean"}}},"ExtensionsNumberResource":{"required":["extensionNumber","id"],"type":"object","properties":{"id":{"type":"string"},"extensionNumber":{"type":"string"}}},"CompanyDirectoryAccountInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"}},"description":"Account data of an extension"},"PhoneNumberResource":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}},"ConflictInfo":{"type":"object","properties":{"id":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"account":{"type":"object","properties":{"federatedName":{"type":"string"},"id":{"type":"string"}}}}},"UserRoleResource":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}}},"ContactDirectorySiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a site"},"name":{"type":"string","description":"Custom name of a site"}},"description":"Site Data"},"UserPhoneNumberResource":{"type":"object","properties":{"e164":{"type":"string"},"formatted":{"type":"string"}}},"CallQueuePresence":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Extension full name"},"extensionNumber":{"type":"string","description":"Extension number"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"}},"description":"Call queue member information"},"acceptQueueCalls":{"type":"boolean","description":"Private member telephony availability status applied to calls of all queues"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability in this particular queue"}}}}}},"CallQueueUpdatePresence":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension - queue member"}},"description":"Call queue member information"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability for calls of this queue"}}}}}},"PresenceInfoResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the presence resource"},"userStatus":{"type":"string","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","enum":["TakeAllCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly","DoNotAcceptAnyCalls","Unknown"]},"message":{"maxLength":75,"minLength":0,"type":"string"},"allowSeeMyPresence":{"type":"boolean","default":false},"ringOnMonitoredCall":{"type":"boolean","default":false},"pickUpCallsOnHold":{"type":"boolean","default":false},"activeCalls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]}}},"AccountPresenceEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"ExtensionPresenceEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"DetailedExtensionPresenceEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"startTime":{"type":"string","description":"Time when the call is actually started"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonyStatus":{"type":"string","description":"Telephony call status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"terminationType":{"type":"string","description":"Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices","enum":["final","intermediate"]},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"DetailedExtensionPresenceWithSIPEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"AccountPresenceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of account presence resource"},"records":{"type":"array","description":"List of Prompts","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a presence info resource"},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"message":{"type":"string","description":"Custom status message (as previously published by user)"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"RingCentral Meetings presence","enum":["Connected","Disconnected"]},"activeCalls":{"type":"array","description":"Information on active calls","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"ExtensionCallQueueUpdatePresenceList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}}}}},"ExtensionCallQueuePresenceList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}}}}},"IncomingCallEvent":{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"},"event":{"type":"string","description":"Event filter URI"},"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"from":{"type":"string","description":"Phone number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"},"recUrl":{"type":"string","description":"File containing recorded caller name"},"pn_ttl":{"type":"integer","description":"Notification lifetime value in seconds, the default value is 30 seconds"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}},"GetPresenceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a presence info resource"},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"message":{"type":"string","description":"Custom status message (as previously published by user)"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"RingCentral Meetings presence","enum":["Connected","Disconnected"]},"activeCalls":{"type":"array","description":"Information on active calls","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}}}},"CallQueuePresenceEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Agent extension ID"},"callQueueId":{"type":"string","description":"Call queue extension ID"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}},"description":"Notification payload body"}}},"MissedCallEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"pn_apns":{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"}},"description":"APNS (Apple Push Notification Service) information"},"event":{"type":"string","description":"Event filter URI"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"from":{"type":"string","description":"Phone number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"},"recUrl":{"type":"string","description":"File containing recorded caller name"},"pn_ttl":{"type":"integer","description":"Notification lifetime value in seconds, the default value is 30 seconds"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}},"PresenceInfoRequest":{"type":"object","properties":{"userStatus":{"type":"string","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","enum":["TakeAllCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly","DoNotAcceptAnyCalls","Unknown"]},"message":{"maxLength":75,"minLength":0,"type":"string"},"allowSeeMyPresence":{"type":"boolean","default":false},"ringOnMonitoredCall":{"type":"boolean","default":false},"pickUpCallsOnHold":{"type":"boolean","default":false}}},"PresenceNavigationInfoURI":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"CallQueueId":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"}},"description":"Call queue information"},"PresenceNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"AdditionalCQInfo":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"},"GetPresenceExtensionInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"ActiveCallInfo":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}},"PrimaryCQInfo":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"DetailedExtensionPresenceEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"startTime":{"type":"string","description":"Time when the call is actually started"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonyStatus":{"type":"string","description":"Telephony call status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"terminationType":{"type":"string","description":"Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices","enum":["final","intermediate"]},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"DetailedExtensionPresenceWithSIPEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"APSInfo":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"},"CallQueueUpdateMemberPresence":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension - queue member"}},"description":"Call queue member information"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability for calls of this queue"}}},"CallQueueMember":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Extension full name"},"extensionNumber":{"type":"string","description":"Extension number"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"}},"description":"Call queue member information"},"CallQueueMemberId":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension - queue member"}},"description":"Call queue member information"},"DetailedCallInfo":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"CallInfoCQ":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}},"CallQueuePresenceEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Agent extension ID"},"callQueueId":{"type":"string","description":"Call queue extension ID"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}},"description":"Notification payload body"},"AccountPresenceEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"APNSInfo":{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"}},"description":"APNS (Apple Push Notification Service) information"},"ExtensionCallQueuePresence":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}},"ExtensionCallQueueUpdatePresence":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}},"SiteResource":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"},"ExtensionPresenceEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"ActiveCallInfoWithoutSIP":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"startTime":{"type":"string","description":"Time when the call is actually started"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonyStatus":{"type":"string","description":"Telephony call status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"terminationType":{"type":"string","description":"Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices","enum":["final","intermediate"]},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}},"CallQueueMemberPresence":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Extension full name"},"extensionNumber":{"type":"string","description":"Extension number"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"}},"description":"Call queue member information"},"acceptQueueCalls":{"type":"boolean","description":"Private member telephony availability status applied to calls of all queues"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability in this particular queue"}}},"PresencePagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"MeetingPresenceInfo":{"type":"object","properties":{"provider":{"type":"string","description":"Meeting provider","enum":["RCMeetings","Google","Office365"]},"meetingStatus":{"type":"string","description":"RingCentral connection status","enum":["Connected","Disconnected"]}}},"CallQueueInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"},"GlipChatsList":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipTeamInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}},"GlipNoteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}},"GlipTaskInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}},"GlipUpdateTask":{"type":"object","properties":{"subject":{"type":"string","description":"Task name/subject. Max allowed length is 250 characters."},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessCondition":{"type":"string","enum":["Simple","AllAssignees","Percentage"]},"startDate":{"type":"string","description":"Task start date in UTC time zone","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time in UTC time zone","format":"date-time"},"color":{"type":"string","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by. Max allowed legth is 100 characters"},"description":{"type":"string","description":"Task details. Max allowed legth is 102400 characters (100kB)"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}},"GlipPreferencesInfo":{"type":"object","properties":{"chats":{"type":"object","properties":{"maxCount":{"type":"integer"},"leftRailMode":{"type":"string","default":"CombineAllChatTypes","enum":["SeparateAllChatTypes","SeparateConversationsAndTeams","CombineAllChatTypes"]}}}}},"GlipConversationsList":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of conversations","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipPatchTeamBody":{"type":"object","properties":{"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name. Maximum number of characters supported is 250"},"description":{"type":"string","description":"Team description. Maximum number of characters supported is 1000"}}},"GlipPostMembersIdsListBody":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"Identifier(s) of chat members.","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}},"GlipPosts":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of posts","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipEventCreate":{"required":["endTime","startTime","title"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether event has some specific time slot or lasts for whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count'"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events.","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}},"GlipCreateTask":{"required":["assignees","subject"],"type":"object","properties":{"subject":{"type":"string","description":"Task name/subject. Max allowed length is 250 characters."},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessCondition":{"type":"string","default":"Simple","enum":["Simple","AllAssignees","Percentage"]},"startDate":{"type":"string","description":"Task start date in UTC time zone.","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time in UTC time zone.","format":"date-time"},"color":{"type":"string","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group / search by. Max allowed legth is 100 characters."},"description":{"type":"string","description":"Task details. Max allowed legth is 102400 characters (100kB)."},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}},"GlipPostTeamBody":{"required":["name"],"type":"object","properties":{"public":{"type":"boolean","description":"Team access level."},"name":{"type":"string","description":"Team name."},"description":{"type":"string","description":"Team description."},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}},"GlipChatsListWithoutNavigation":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}}},"GlipPatchPostBody":{"type":"object","properties":{"text":{"type":"string","description":"Post text."}}},"GlipGroupList":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of groups/teams/private chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"UpdateUnifiedPresence":{"type":"object","properties":{"glip":{"type":"object","properties":{"visibility":{"type":"string","description":"Visibility setting allowing other users to see Glip presence status","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Availability setting specifing whether to receive Glip notifications or not","enum":["Available","DND"]}}},"telephony":{"type":"object","properties":{"availability":{"type":"string","description":"Telephony DND status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}}}}},"CreateGlipConversationRequest":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"List of glip members. The maximum supported number of IDs is 15. User's own ID is optional. If `members` section is omitted then 'Personal' chat will be returned","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}},"GlipConversationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}},"GlipTeamsList":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of teams","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipPostMembersListBody":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}},"GlipPostsList":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of posts","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipCreatePost":{"type":"object","properties":{"activity":{"type":"string"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)."},"text":{"type":"string","description":"Text of a post"},"groupId":{"type":"string","description":"Internal identifier of a group"},"attachments":{"type":"array","description":"List of attachments to be posted","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}}},"personIds":{"type":"array","items":{"type":"string"}},"system":{"type":"boolean"}}},"GetGlipNoteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"body":{"type":"string","description":"Text of a note"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}},"EditGroupRequest":{"type":"object","properties":{"addedPersonIds":{"type":"array","description":"List of users to be added to a team","items":{"type":"string"}},"addedPersonEmails":{"type":"array","description":"List of user email addresses to be added to a team (i.e. as guests)","items":{"type":"string"}},"removedPersonIds":{"type":"array","description":"List of users to be removed from a team","items":{"type":"string"}}}},"UnifiedPresence":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}},"GlipChatInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}},"GlipPostPostBody":{"type":"object","description":"Post data. At least one attribute should be provided (text or attachments)","properties":{"text":{"type":"string","description":"Text of a post. Maximum length is 10000 symbols. Mentions can be added in .md format [![:Type](id)]"},"attachments":{"type":"array","description":"Identifier(s) of attachments. Maximum number of attachments is 25","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}},"GlipMessageAttachmentInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}},"GlipEventInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}},"GlipNoteCreate":{"required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Title of a note. Max allowed legth is 250 characters"},"body":{"type":"string","description":"Contents of a note; HTML-markuped text. Max allowed length is 1048576 characters (1 Mb)."}}},"GlipWebhookInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}},"UpdateGlipEveryoneRequest":{"type":"object","properties":{"name":{"type":"integer","description":"Everyone chat name. Maximum number of characters supported is 250"},"description":{"type":"string","description":"Everyone chat description. Maximum number of characters supported is 1000"}}},"GlipPostInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}},"GlipMessageAttachmentInfoRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}},"GlipEventsInfo":{"type":"object","properties":{"records":{"type":"array","description":"List of events created by the current user","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipNotesInfo":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}},"GlipTaskList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}}}}},"GlipCompleteTask":{"type":"object","properties":{"status":{"type":"string","description":"Completeness status. 'Mandatory' if `completenessCondition` is set to `Simple`, otherwise 'Optional'","enum":["Incomplete","Complete"]},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of a task with the 'Percentage' completeness condition. 'Mandatory' if `completenessCondition` is set to `Percentage`, otherwise 'Optional'"}}},"GlipWebhookList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}},"GlipGroupInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}},"UnifiedPresenceList":{"type":"array","items":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of the resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}}}}},"GlipEveryoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone"]},"name":{"type":"string","description":"Chat name"},"description":{"type":"string","description":"Chat description"},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"}}},"GlipPostEvent":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"eventType":{"type":"string","description":"Type of a post event","enum":["PostAdded","PostChanged","PostRemoved"]},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post. 'TextMessage' - an incoming text message; 'PersonJoined' - a message notifying that person has joined a conversation; 'PersonsAdded' - a message notifying that a person(s) were added to a conversation","enum":["TextMessage","PersonJoined","PersonsAdded","Card"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Message text"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For PersonsAdded post type only. Identifiers of persons added to a group","items":{"type":"string"}},"removedPersonIds":{"type":"array","description":"For PersonsRemoved post type only. Identifiers of persons removed from a group","items":{"type":"string"}},"mentions":{"type":"array","description":"List of at mentions in post text with names.","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}},"GlipPersonInfo":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"firstName":{"type":"string","description":"First name of a user"},"lastName":{"type":"string","description":"Last name of a user"},"email":{"type":"string","description":"Email of a user"},"avatar":{"type":"string","description":"Photo of a user"},"companyId":{"type":"string","description":"Internal identifier of a company"},"creationTime":{"type":"string","description":"Time of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Time of the last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}},"GlipCompany":{"required":["creationTime","id","lastModifiedTime"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"},"name":{"type":"string","description":"Name of a company"},"domain":{"type":"string","description":"Domain name of a company"},"creationTime":{"type":"string","description":"Datetime of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"},"lastModifiedTime":{"type":"string","description":"Datetime of last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"}}},"GlipGroupsEvent":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"eventType":{"type":"string","description":"Type of a group event. Only the person who joined/was added to a group will receive 'GroupJoined' notification. Only the person who left/was removed from a group will receive 'GroupLeft' notification","enum":["GroupRenamed","GroupJoined","GroupLeft","GroupChanged"]}}},"GlipCreateGroup":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Type of a group to be created. 'PrivateChat' is a group of 2 members. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Team"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members. For 'PrivateChat' group type 2 members only are supported”","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}},"UnifiedPresenceGlip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"GlipMessageAttachmentAuthorInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"LastModifiedByInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"LockedByInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"TaskAssigneeInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}},"GlipMessageAttachmentFootnoteInfo":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"GlipPreferencesChats":{"type":"object","properties":{"maxCount":{"type":"integer"},"leftRailMode":{"type":"string","default":"CombineAllChatTypes","enum":["SeparateAllChatTypes","SeparateConversationsAndTeams","CombineAllChatTypes"]}}},"AssigneeInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}},"UnifiedPresenceListEntry":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of the resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}}}},"UpdateUnifiedPresenceTelephony":{"type":"object","properties":{"availability":{"type":"string","description":"Telephony DND status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}}},"GlipMentionsInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}},"CreateGlipMember":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}},"GlipTaskRecurrenceInfo":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"TaskAttachment":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}},"UpdateUnifiedPresenceGlip":{"type":"object","properties":{"visibility":{"type":"string","description":"Visibility setting allowing other users to see Glip presence status","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Availability setting specifing whether to receive Glip notifications or not","enum":["Available","DND"]}}},"CreatorInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"GlipMemberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}},"UnifiedPresenceMeeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"},"GlipAPNSInfo":{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"},"timestamp":{"type":"string","description":"Datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"unread":{"type":"integer","description":"Count of glip unread messages"}},"description":"Unread messages data"}},"description":"Apple notification data"},"GlipUnreadMessageCountInfo":{"type":"object","properties":{"unread":{"type":"integer","description":"Count of glip unread messages"}},"description":"Unread messages data"},"UnifiedPresenceTelephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"GCMInfo":{"type":"object","properties":{"priority":{"type":"string","description":"Notification priority, if the value is 'high' then notification is turned on even if the application is in background","enum":["high","normal"]},"time_to_live":{"type":"integer","description":"Notification lifetime value in seconds, the default value is 30 seconds"},"data":{"type":"object","properties":{"event":{"type":"string","description":"Event filter URI"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"_from":{"type":"string","description":"Phone number of a caller"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}},"description":"GCM data"}},"description":"GCM data"},"GCMData":{"type":"object","properties":{"event":{"type":"string","description":"Event filter URI"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"_from":{"type":"string","description":"Phone number of a caller"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}},"description":"GCM data"},"GlipAttachmentInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}},"GlipNavigationInfo":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}},"GlipMessageAttachmentFieldsInfo":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}},"MeetingResponseResource":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}},"AccountLockedSettingResponse":{"type":"object","properties":{"scheduleMeeting":{"type":"object","properties":{"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)"},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)"},"audioOptions":{"type":"array","description":"Determines how participants can join the audio channel of a meeting","items":{"type":"string","enum":["Phone","ComputerAudio","ThirdParty"]}},"allowJoinBeforeHost":{"type":"boolean","description":"Allows participants to join the meeting before the host arrives"},"usePmiForScheduledMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when scheduling a meeting"},"usePmiForInstantMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when starting an instant meeting"},"requirePasswordForSchedulingNewMeetings":{"type":"boolean","description":"A password will be generated when scheduling a meeting and participants will require password to join a meeting. The Personal Meeting ID (PMI) meetings are not included"},"requirePasswordForScheduledMeetings":{"type":"boolean","description":"Specifies whether to require a password for meetings which have already been scheduled"},"defaultPasswordForScheduledMeetings":{"type":"string","description":"Password for already scheduled meetings. Users can set it individually"},"requirePasswordForInstantMeetings":{"type":"boolean","description":"A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled"},"requirePasswordForPmiMeetings":{"type":"string","description":"Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only)","enum":["all","none","jbhOnly"]},"pmiPassword":{"type":"string","description":"The default password for Personal Meeting ID (PMI) meetings"},"pstnPasswordProtected":{"type":"boolean","description":"Specifies whether to generate and require a password for participants joining by phone"}},"description":"Scheduling meeting settings locked on account level || Settings defining how to schedule user meetingsxs"},"recording":{"type":"object","properties":{"localRecording":{"type":"boolean","description":"Allows hosts and participants to record a meeting to a local file"},"cloudRecording":{"type":"boolean","description":"Allows hosts to record and save a meeting/webinar in the cloud"},"recordSpeakerView":{"type":"boolean","description":"Allows to record active speaker with the shared screen","default":false},"recordGalleryView":{"type":"boolean","description":"Allows to record gallery view with the shared screen","default":false},"recordAudioFile":{"type":"boolean","description":"Allows to record an audio-only file","default":false},"saveChatText":{"type":"boolean","description":"Allows to save chat text from a meeting","default":false},"showTimestamp":{"type":"boolean","description":"Allows to show timestamp on video","default":false},"autoRecording":{"type":"string","description":"Automatical recording (local/cloud/none) of meetings as they start","default":"local","enum":["local","cloud","none"]},"autoDeleteCmr":{"type":"string","description":"Automatical deletion of cloud recordings","default":"false"},"autoDeleteCmrDays":{"type":"integer","description":"A specified number of days for automatical deletion of cloud recordings, the value range is 1-60"}},"description":"Meeting recording settings locked on account level"},"telephony":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"}}}}},"MeetingServiceInfoResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"supportUri":{"type":"string"},"intlDialInNumbersUri":{"type":"string"},"externalUserInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}},"dialInNumbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"formattedNumber":{"type":"string"},"location":{"type":"string"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}}}}}}},"MeetingServiceInfoRequest":{"type":"object","properties":{"externalUserInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}}}},"AssistantsResource":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}},"MeetingRequestResource":{"type":"object","properties":{"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"password":{"type":"string","description":"Meeting password"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","default":false},"startHostVideo":{"type":"boolean","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"usePersonalMeetingId":{"type":"boolean","description":"If true, then personal user's meeting ID is applied for creation of this meeting"},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"recurrence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}},"MeetingUserSettingsResponse":{"type":"object","properties":{"recording":{"type":"object","properties":{"localRecording":{"type":"boolean","description":"Allows hosts and participants to record a meeting to a local file"},"cloudRecording":{"type":"boolean","description":"Allows hosts to record and save a meeting/webinar in the cloud"},"recordSpeakerView":{"type":"boolean","description":"Allows to record active speaker with the shared screen","default":false},"recordGalleryView":{"type":"boolean","description":"Allows to record gallery view with the shared screen","default":false},"recordAudioFile":{"type":"boolean","description":"Allows to record an audio-only file","default":false},"saveChatText":{"type":"boolean","description":"Allows to save chat text from a meeting","default":false},"showTimestamp":{"type":"boolean","description":"Allows to show timestamp on video","default":false},"autoRecording":{"type":"string","description":"Automatical recording (local/cloud/none) of meetings as they start","default":"local","enum":["local","cloud","none"]},"autoDeleteCmr":{"type":"string","description":"Automatical deletion of cloud recordings","default":"false"},"autoDeleteCmrDays":{"type":"integer","description":"A specified number of days for automatical deletion of cloud recordings, the value range is 1-60"}},"description":"Meeting recording settings locked on account level"},"scheduleMeeting":{"type":"object","properties":{"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)"},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)"},"audioOptions":{"type":"array","description":"Determines how participants can join the audio channel of a meeting","items":{"type":"string","enum":["Phone","ComputerAudio","ThirdParty"]}},"allowJoinBeforeHost":{"type":"boolean","description":"Allows participants to join the meeting before the host arrives"},"usePmiForScheduledMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when scheduling a meeting"},"usePmiForInstantMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when starting an instant meeting"},"requirePasswordForSchedulingNewMeetings":{"type":"boolean","description":"A password will be generated when scheduling a meeting and participants will require password to join a meeting. The Personal Meeting ID (PMI) meetings are not included"},"requirePasswordForScheduledMeetings":{"type":"boolean","description":"Specifies whether to require a password for meetings which have already been scheduled"},"defaultPasswordForScheduledMeetings":{"type":"string","description":"Password for already scheduled meetings. Users can set it individually"},"requirePasswordForInstantMeetings":{"type":"boolean","description":"A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled"},"requirePasswordForPmiMeetings":{"type":"string","description":"Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only)","enum":["all","none","jbhOnly"]},"pmiPassword":{"type":"string","description":"The default password for Personal Meeting ID (PMI) meetings"},"pstnPasswordProtected":{"type":"boolean","description":"Specifies whether to generate and require a password for participants joining by phone"}},"description":"Scheduling meeting settings locked on account level || Settings defining how to schedule user meetingsxs"},"telephony":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"},"audioConferenceInfo":{"type":"boolean","description":"Users can join the meeting using the existing 3rd party audio configuration"}}}}},"AssistedUsersResource":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}},"PublicMeetingInvitationResponse":{"type":"object","properties":{"invitation":{"type":"string","description":"Meeting invitation"}}},"MeetingsResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"navigation":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"firstPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"RecurrenceInfo":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"MeetingCallType":{"type":"string","enum":["call-in","call-out"]},"MeetingUserConsumptionResource":{"type":"object","properties":{"number":{"type":"integer"},"topic":{"type":"string"},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer"},"participants":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"joinedAt":{"type":"string","format":"date-time"},"leftAt":{"type":"string","format":"date-time"}}}}}},"MeetingsNavigationInfo":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"firstPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}},"MeetingTollType":{"type":"string","enum":["Toll","TollFree"]},"MeetingAccountConsumptionResource":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string"}}},"type":{"type":"string","enum":["Toll","TollFree"]},"meetings":{"type":"integer","description":"Total number of meetings started by the given extension"},"participants":{"type":"integer","description":"Total number of participants in the meetings"},"minutes":{"type":"integer","description":"Total number of minutes consumed by the meetings"}}},"TelephonyLockedSettings":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"}}},"DialInNumberResource":{"type":"object","properties":{"phoneNumber":{"type":"string"},"formattedNumber":{"type":"string"},"location":{"type":"string"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}}}},"MeetingHostDetailsResource":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"AssistedUserResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"FeatureResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a meeting feature"},"available":{"type":"boolean","description":"Specifies whether the feature is available or not"}},"description":"Information on an account meeting feature"},"MeetingLinks":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"MeetingParticipantDetails":{"type":"object","properties":{"name":{"type":"string"},"joinedAt":{"type":"string","format":"date-time"},"leftAt":{"type":"string","format":"date-time"}}},"MeetingAudioDetailsResource":{"type":"object","properties":{"id":{"type":"string","description":"Meeting ID"},"phoneNumber":{"type":"string"},"type":{"type":"string","enum":["call-in","call-out"]},"host":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string","format":"email"}}},"startTime":{"type":"string","format":"date-time"},"endTime":{"type":"string","format":"date-time"},"duration":{"type":"integer","description":"Duration of a meeting"},"total":{"type":"integer"}}},"AssistantResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"UserMeetingRecordingSetting":{"type":"object","properties":{"localRecording":{"type":"boolean","description":"Allows hosts and participants to record a meeting to a local file"},"cloudRecording":{"type":"boolean","description":"Allows hosts to record and save a meeting/webinar in the cloud"},"recordSpeakerView":{"type":"boolean","description":"Allows to record active speaker with the shared screen","default":false},"recordGalleryView":{"type":"boolean","description":"Allows to record gallery view with the shared screen","default":false},"recordAudioFile":{"type":"boolean","description":"Allows to record an audio-only file","default":false},"saveChatText":{"type":"boolean","description":"Allows to save chat text from a meeting","default":false},"showTimestamp":{"type":"boolean","description":"Allows to show timestamp on video","default":false},"autoRecording":{"type":"string","description":"Automatical recording (local/cloud/none) of meetings as they start","default":"local","enum":["local","cloud","none"]},"autoDeleteCmr":{"type":"string","description":"Automatical deletion of cloud recordings","default":"false"},"autoDeleteCmrDays":{"type":"integer","description":"A specified number of days for automatical deletion of cloud recordings, the value range is 1-60"}},"description":"Meeting recording settings locked on account level"},"MeetingScheduleResource":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"MeetingExternalUserInfoResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}},"MeetingExtensionResource":{"type":"object","properties":{"id":{"type":"string"}}},"MeetingReportTotalsResource":{"type":"object","properties":{"meetings":{"type":"integer","description":"Total number of meetings started"},"participants":{"type":"integer","description":"Total number of participants in all the meetings"},"minutes":{"type":"integer","description":"Total number of minutes consumed by the meetings"}}},"CountryResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"ScheduleUserMeetingInfo":{"type":"object","properties":{"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)"},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)"},"audioOptions":{"type":"array","description":"Determines how participants can join the audio channel of a meeting","items":{"type":"string","enum":["Phone","ComputerAudio","ThirdParty"]}},"allowJoinBeforeHost":{"type":"boolean","description":"Allows participants to join the meeting before the host arrives"},"usePmiForScheduledMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when scheduling a meeting"},"usePmiForInstantMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when starting an instant meeting"},"requirePasswordForSchedulingNewMeetings":{"type":"boolean","description":"A password will be generated when scheduling a meeting and participants will require password to join a meeting. The Personal Meeting ID (PMI) meetings are not included"},"requirePasswordForScheduledMeetings":{"type":"boolean","description":"Specifies whether to require a password for meetings which have already been scheduled"},"defaultPasswordForScheduledMeetings":{"type":"string","description":"Password for already scheduled meetings. Users can set it individually"},"requirePasswordForInstantMeetings":{"type":"boolean","description":"A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled"},"requirePasswordForPmiMeetings":{"type":"string","description":"Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only)","enum":["all","none","jbhOnly"]},"pmiPassword":{"type":"string","description":"The default password for Personal Meeting ID (PMI) meetings"},"pstnPasswordProtected":{"type":"boolean","description":"Specifies whether to generate and require a password for participants joining by phone"}},"description":"Scheduling meeting settings locked on account level || Settings defining how to schedule user meetingsxs"},"MeetingsPagingInfo":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"HostInfoRequest":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"TimezoneResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"TelephonyUserMeetingSettings":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"},"audioConferenceInfo":{"type":"boolean","description":"Users can join the meeting using the existing 3rd party audio configuration"}}},"MeetingsNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"MeetingDailyUsageResource":{"type":"object","properties":{"date":{"type":"string","format":"date"},"meetings":{"type":"integer"},"participants":{"type":"integer"},"minutes":{"type":"integer"},"new_users":{"type":"integer"}}},"ModifySubscriptionRequest":{"required":["eventFilters"],"type":"object","properties":{"eventFilters":{"type":"array","description":"Collection of URIs to API resources","items":{"type":"string"}},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years)"}}},"RecordsCollectionResourceSubscriptionResponse":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}},"CreateSubscriptionRequest":{"required":["deliveryMode","eventFilters"],"type":"object","properties":{"eventFilters":{"type":"array","description":"Collection of URIs to API resources","items":{"type":"string"}},"deliveryMode":{"type":"object","properties":{"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"address":{"type":"string","description":"Mandatory for 'WebHook' transport type, URL of a consumer service (cannot be changed during subscription update)"},"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False'"},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"verificationToken":{"type":"string","description":"Verification key of a subscription ensuring data security. Supported for 'Webhook' transport type"}},"description":"Notification delivery settings"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years)"}}},"SubscriptionInfo":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}},"NotificationDeliveryModeRequest":{"type":"object","properties":{"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"address":{"type":"string","description":"Mandatory for 'WebHook' transport type, URL of a consumer service (cannot be changed during subscription update)"},"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False'"},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"verificationToken":{"type":"string","description":"Verification key of a subscription ensuring data security. Supported for 'Webhook' transport type"}},"description":"Notification delivery settings"},"DisabledFilterInfo":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}},"NotificationDeliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"NotificationBlacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"AuthProfileResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"permissions":{"type":"array","items":{"type":"object","properties":{"permission":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"effectiveRole":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["Account","AllExtensions","Federation","NonUserExtensions","RoleBased","Self","UserExtensions"]}}}}}}},"AuthProfileCheckResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"successful":{"type":"boolean","default":false},"details":{"type":"object","properties":{"permission":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"effectiveRole":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["Account","AllExtensions","Federation","NonUserExtensions","RoleBased","Self","UserExtensions"]}}}}}},"RoleIdResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"RNPPagingInfo":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"UserGroupMemberResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}},"UserGroupCreationMemberResource":{"type":"object","properties":{"id":{"type":"string"},"extensionNumber":{"type":"string"}}},"ExtensionIdResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}},"ActivePermissionResource":{"type":"object","properties":{"permission":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"effectiveRole":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["Account","AllExtensions","Federation","NonUserExtensions","RoleBased","Self","UserExtensions"]}}}},"PermissionIdResource":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"ExtensionWithRolesResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"extensionId":{"type":"string"},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"autoAssigned":{"type":"boolean","default":false},"displayName":{"type":"string"},"siteCompatible":{"type":"boolean"},"siteRestricted":{"type":"boolean"}}}}}},"RoleResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"displayName":{"maxLength":128,"minLength":0,"pattern":"^((?!(<|>|\\/|\\\")).)*$","type":"string"},"description":{"maxLength":2000,"minLength":0,"pattern":"^((?!(<|>|\\/|\\\")).)*$","type":"string"},"siteCompatible":{"type":"boolean","description":"Site compatibility of a user role"},"custom":{"type":"boolean","default":false},"scope":{"type":"string"},"hidden":{"type":"boolean","default":false},"lastUpdated":{"type":"string","format":"date-time"},"permissions":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}}}}},"PermissionResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"assignable":{"type":"boolean","default":false},"readOnly":{"type":"boolean","default":false},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Incompatible","Compatible","Independent"]},"category":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"includedPermissions":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}}}}},"UserGroupResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"pattern":"^\\d+$","type":"string"},"displayName":{"maxLength":128,"minLength":0,"pattern":"^((?!(<|>|\\/|\\\")).)*$","type":"string"},"description":{"maxLength":2000,"minLength":0,"pattern":"^((?!(<|>|\\/|\\\")).)*$","type":"string"},"managers":{"type":"array","description":"User group manager extension information","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource","format":"uri"},"id":{"type":"string","description":"Internal identifier of an extension"},"extensionNumber":{"type":"string","description":"Number of an extension"},"firstName":{"type":"string","description":"First name of a user"},"lastName":{"type":"string","description":"Last name of a user"}}}},"members":{"type":"array","description":"User group member extension information","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}}}},"UserGroupManagerResource":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource","format":"uri"},"id":{"type":"string","description":"Internal identifier of an extension"},"extensionNumber":{"type":"string","description":"Number of an extension"},"firstName":{"type":"string","description":"First name of a user"},"lastName":{"type":"string","description":"Last name of a user"}}},"LegacyPermission":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"RNPNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"PermissionCategoryResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"}}},"UserGroupIdResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"UserGroupBulkAssignItem":{"type":"object","properties":{"groupId":{"type":"string"},"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}},"AssignedRoleResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"autoAssigned":{"type":"boolean","default":false},"displayName":{"type":"string"},"siteCompatible":{"type":"boolean"},"siteRestricted":{"type":"boolean"}}},"RNPNavigationInfo":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"firstPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}},"PermissionCategoryIdResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"UserGroupCreationManagerResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"extensionNumber":{"type":"string","description":"Number of an extension"},"firstName":{"type":"string","description":"First name of a user"},"lastName":{"type":"string","description":"Last name of a user"}}},"GetExtensionForwardingNumberListResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the forwarding number list resource"},"records":{"type":"array","description":"List of forwarding phone numbers","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateForwardingNumberRequest":{"type":"object","properties":{"flipNumber":{"type":"integer","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Forwarding/Call flip phone type. If specified, 'label' attribute value is ignored. The default value is 'Other'","enum":["PhoneLine","Home","Mobile","Work","Other"]},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"}}},"UpdateForwardingNumberRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}},"CompanyAnsweringRuleInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive","default":true},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}},"CompanyAnsweringRuleList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an answering rule resource"},"records":{"type":"array","description":"List of company answering rules","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"type":{"type":"string","description":"Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"}}},"CompanyBusinessHours":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource "},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"uri":"https.../restapi/v1.0/account/401800045008/business-hours","schedule":{"weeklyRanges":{"wednesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"tuesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}]}}}},"BlockedAllowedPhoneNumbersList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a list of blocked/allowed phone numbers resource"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}},"description":"List of blocked or allowed phone numbers"},"CallRecordingExtensions":{"type":"object","properties":{"uri":{"type":"string","description":"Link to call recording extension list resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Name of an extension"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"GetUserBusinessHoursResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"uri":"https.../restapi/v1.0/account/401800045008/extension/401800045008/business-hours","schedule":{"weeklyRanges":{"wednesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"tuesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}]}}}},"AddBlockedAllowedPhoneNumber":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","default":"Blocked","enum":["Blocked","Allowed"]}},"description":"Updates either blocked or allowed phone number list with a new phone number."},"AnsweringRuleInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"callers":{"type":"array","description":"Answering rules are applied when calls are received from specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}},"DictionaryGreetingList":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of greetings list resource"},"records":{"type":"array","description":"List of greetings","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting"},"uri":{"type":"string","description":"Link to a greeting"},"name":{"type":"string","description":"Name of a greeting"},"usageType":{"type":"string","description":"Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension.","enum":["UserExtensionAnsweringRule","ExtensionAnsweringRule","DepartmentExtensionAnsweringRule","BlockedCalls","CallRecording","CompanyAnsweringRule","CompanyAfterHoursAnsweringRule","LimitedExtensionAnsweringRule","VoicemailExtensionAnsweringRule","AnnouncementExtensionAnsweringRule","SharedLinesGroupAnsweringRule"]},"text":{"type":"string","description":"Text of a greeting, if any"},"contentUri":{"type":"string","description":"Link to a greeting content (audio file), if any"},"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","AutomaticRecording","BlockedCallersAll","BlockedCallersSpecific","BlockedNoCallerId","BlockedPayPhones","ConnectingMessage","ConnectingAudio","StartRecording","StopRecording","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Company"]},"category":{"type":"string","description":"Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None']","enum":["Music","Message","RingTones","None"]},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallerBlockingSettingsUpdate":{"type":"object","properties":{"mode":{"type":"string","description":"Call blocking options: either specific or all calls and faxes","enum":["Specific","All"]},"noCallerId":{"type":"string","description":"Determines how to handle calls with no caller ID in 'Specific' mode","enum":["BlockCallsAndFaxes","BlockFaxes","Allow"]},"payPhones":{"type":"string","description":"Blocking settings for pay phones","enum":["Block","Allow"]},"greetings":{"type":"array","description":"List of greetings played for blocked callers","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}}}},"description":"Returns the lists of blocked and allowed phone numbers"},"CompanyBusinessHoursUpdateRequest":{"type":"object","properties":{"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"schedule":{"weeklyRanges":{"tuesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}],"wednesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}]}}}},"CompanyAnsweringRuleUpdate":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect','Bypass']","enum":["Operator","Disconnect","Bypass"]},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"extension":{"type":"string","description":"Internal identifier of the extension the call is forwarded to. Supported for 'Bypass' mode only (that should be specified in `callHandlingAction` field)"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}},"PromptInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}},"CallRecordingSettingsResource":{"type":"object","properties":{"onDemand":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controlling OnDemand Call Recording settings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"}}},"automatic":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controling Automatic Call Recording settings"},"outboundCallTones":{"type":"boolean","description":"Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings"},"outboundCallAnnouncement":{"type":"boolean","description":"Flag for controlling 'Play periodic tones for outbound calls' settings"},"allowMute":{"type":"boolean","description":"Flag for controlling 'Allow mute in auto call recording' settings"},"extensionCount":{"type":"integer","description":"Total amount of extension that are used in call recordings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"},"maxNumberLimit":{"type":"integer","description":"Max number of automatic call recordings per account, the default value is 100 000"}}},"greetings":{"type":"array","description":"Collection of Greeting Info","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"mode":{"type":"string","description":"'Default' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then 'Custom' value is returned.","enum":["Default","Custom"]}}}}}},"UserBusinessHoursUpdateRequest":{"type":"object","properties":{"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}}},"CustomUserGreetingInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom user greeting"},"id":{"type":"string","description":"Internal identifier of a custom user greeting"},"type":{"type":"string","description":"Type of a custom user greeting","enum":["Introductory","Announcement","InterruptPrompt","ConnectingAudio","ConnectingMessage","Voicemail","Unavailable","HoldMusic","PronouncedName"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"}}},"DictionaryGreetingInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting"},"uri":{"type":"string","description":"Link to a greeting"},"name":{"type":"string","description":"Name of a greeting"},"usageType":{"type":"string","description":"Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension.","enum":["UserExtensionAnsweringRule","ExtensionAnsweringRule","DepartmentExtensionAnsweringRule","BlockedCalls","CallRecording","CompanyAnsweringRule","CompanyAfterHoursAnsweringRule","LimitedExtensionAnsweringRule","VoicemailExtensionAnsweringRule","AnnouncementExtensionAnsweringRule","SharedLinesGroupAnsweringRule"]},"text":{"type":"string","description":"Text of a greeting, if any"},"contentUri":{"type":"string","description":"Link to a greeting content (audio file), if any"},"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","AutomaticRecording","BlockedCallersAll","BlockedCallersSpecific","BlockedNoCallerId","BlockedPayPhones","ConnectingMessage","ConnectingAudio","StartRecording","StopRecording","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Company"]},"category":{"type":"string","description":"Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None']","enum":["Music","Message","RingTones","None"]},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CustomCompanyGreetingInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension custom greeting"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of a company greeting","enum":["Company","StartRecording","StopRecording","AutomaticRecording"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"uri":{"type":"string","description":"Link to a greeting language"},"name":{"type":"string","description":"Name of a greeting language"},"localeCode":{"type":"string","description":"Locale code of a greeting language"}},"description":"Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording'"}}},"BulkAccountCallRecordingsResource":{"type":"object","properties":{"addedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}},"updatedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}},"removedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}}}},"CallRecordingCustomGreetings":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"custom":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom company greeting"},"id":{"type":"string","description":"Internal identifier of a custom company greeting"}},"description":"Custom greeting data"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"Custom greeting language"}}}}},"description":"Returns data on call recording custom greetings."},"ForwardingNumberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}},"CustomAnsweringRuleInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"callers":{"type":"array","description":"Answering rules are applied when calls are received from specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}},"UserAnsweringRuleList":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule list resource","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"},"records":{"type":"array","description":"List of answering rules","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule/business-hours-rule"},"id":{"type":"string","description":"Internal identifier of an asnwering rule","example":"business-hours-rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)","example":1},"totalPages":{"type":"integer","description":"The total number of pages in a dataset.","example":1},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied","example":100},"totalElements":{"type":"integer","description":"The total number of elements in a dataset.","example":1},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty","example":0},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty","example":0}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"nextPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}}}}}},"UpdateIVRPromptRequest":{"type":"object","properties":{"filename":{"type":"string","description":"Name of a file to be uploaded as a prompt"}}},"CreateAnsweringRuleRequest":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'"},"type":{"type":"string","description":"Type of an answering rule. The 'Custom' value should be specified"},"name":{"type":"string","description":"Name of an answering rule specified by user"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]}}},"CallerBlockingSettings":{"type":"object","properties":{"mode":{"type":"string","description":"Call blocking options: either specific or all calls and faxes","enum":["Specific","All"]},"noCallerId":{"type":"string","description":" Determines how to handle calls with no caller ID in 'Specific' mode","enum":["BlockCallsAndFaxes","BlockFaxes","Allow"]},"payPhones":{"type":"string","description":"Blocking settings for pay phones","enum":["Block","Allow"]},"greetings":{"type":"array","description":"List of greetings played for blocked callers","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}}}},"description":"Returns the lists of blocked and allowed phone numbers"},"BlockedAllowedPhoneNumberInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"},"UpdateAnsweringRuleRequest":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an answering rule"},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'"},"softPhonesRingCount":{"type":"integer","description":"Specifies delay between ring on apps and starting of a call forwarding"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal. Not returned for inactive numbers"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group). For inactive numbers the default value ('4') is returned"},"enabled":{"type":"boolean","description":"Phone number status"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'"},"name":{"type":"string","description":"Name of an answering rule specified by user"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"showInactiveNumbers":{"type":"boolean","description":"Indicates whether inactive numbers should be returned or not"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"}}},"CompanyAnsweringRuleRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"type":{"type":"string","description":"Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']","enum":["BusinessHours","AfterHours","Custom"]},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"string","description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}},"IVRPrompts":{"type":"object","properties":{"uri":{"type":"string","description":"Link to prompts library resource"},"records":{"type":"array","description":"List of Prompts","items":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"IVRMenuInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}},"UserBusinessHoursUpdateResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}}},"WeeklyScheduleInfo":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"AudioPromptInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"CallHandlingNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"TransferExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"AddedNumberInfo":{"required":["phoneNumber","status"],"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom label of a phone number"},"status":{"type":"string","description":"Type of list the phone number should be added to","enum":["Blocked","Allowed"]}}},"CalledNumberInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}},"RangesInfo":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}},"CreateAnsweringRuleForwardingNumberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}},"GreetingResource":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"mode":{"type":"string","description":"'Default' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then 'Custom' value is returned.","enum":["Default","Custom"]}}},"CreateForwardingNumberDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"PromptLanguageResource":{"type":"object","properties":{"name":{"type":"string"},"localeCode":{"type":"string"}}},"CallHandlingPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"CompanyAnsweringRuleWeeklyScheduleInfoRequest":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"IvrSingleMenuResource":{"type":"object","properties":{"type":{"type":"string","description":"Type of a call handling rule","enum":["AfterHours","BusinessHours"]},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension custom greeting"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of a company greeting","enum":["Company","StartRecording","StopRecording","AutomaticRecording"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"uri":{"type":"string","description":"Link to a greeting language"},"name":{"type":"string","description":"Name of a greeting language"},"localeCode":{"type":"string","description":"Locale code of a greeting language"}},"description":"Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording'"}}}}},"CompanyAnsweringRuleExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}}},"ForwardingInfo":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"CallHandlingNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"RuleInfo":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}},"RuleInfoCreateRuleRequest":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal. Not returned for inactive numbers"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group). For inactive numbers the default value ('4') is returned"},"enabled":{"type":"boolean","description":"Phone number status"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"}}}}}},"CallRecordingExtensionResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}},"UserAnsweringRuleListNavigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"nextPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}}}},"CallersInfo":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}},"TransferredExtensionInfo":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"BlockedNumberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a blocked number"},"uri":{"type":"string","description":"Canonical URI of a blocked number"},"name":{"type":"string","description":"Name assigned by a user to a blocked phone number"},"phoneNumber":{"type":"string","description":"Phone number to be blocked"}}},"TransferInfo":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}},"CallRecordingCustomGreetingLanguage":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"Custom greeting language"},"CallRecordingExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Name of an extension"}}},"VoicemailInfo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"ListCompanyAnsweringRuleInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"type":{"type":"string","description":"Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}}}}},"CustomGreetingInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}},"IVRMenuPromptInfo":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"ExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}},"UserAnsweringRuleListRecord":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule/business-hours-rule"},"id":{"type":"string","description":"Internal identifier of an asnwering rule","example":"business-hours-rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}},"QueueInfo":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"GreetingInfo":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}},"ScheduleInfoUserBusinessHours":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"},"IvrResourceOperatorInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extensionNumber":{"type":"string"}}},"UnconditionalForwardingInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"CompanyAnsweringRuleScheduleInfoRequest":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"CustomCompanyGreetingLanguageInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"uri":{"type":"string","description":"Link to a greeting language"},"name":{"type":"string","description":"Name of a greeting language"},"localeCode":{"type":"string","description":"Locale code of a greeting language"}},"description":"Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording'"},"PresetInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"OnDemandResource":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controlling OnDemand Call Recording settings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"}}},"CallersInfoRequest":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}},"IVRMenuActionsInfo":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}},"BlockedCallerGreetingInfo":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}},"PromptLanguageInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"},"IvrKeyPressResource":{"type":"object","properties":{"input":{"type":"string","enum":["1","2","3","4","5","6","7","8","9","0","Hash","Star","NoInput"]},"action":{"type":"string","enum":["Connect","Voicemail","DialByName","Transfer","Disconnect","Repeat","ReturnToRoot","ReturnToPrevious"]}}},"IvrTopMenuResource":{"type":"object","properties":{"name":{"type":"string"},"extensionNumber":{"type":"string"},"prompt":{"type":"object","properties":{"mode":{"type":"string","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{}},"text":{"maxLength":1000,"type":"string"},"language":{"type":"object","properties":{"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"actions":{"type":"array","items":{"type":"object","properties":{"input":{"type":"string","enum":["1","2","3","4","5","6","7","8","9","0","Hash","Star","NoInput"]},"action":{"type":"string","enum":["Connect","Voicemail","DialByName","Transfer","Disconnect","Repeat","ReturnToRoot","ReturnToPrevious"]}}}}}},"FixedOrderAgents":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}},"ForwardingNumberInfoRulesCreateRuleRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"}}},"CallRecordingCustomGreeting":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"custom":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom company greeting"},"id":{"type":"string","description":"Internal identifier of a custom company greeting"}},"description":"Custom greeting data"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"Custom greeting language"}}},"CallRecordingCustomGreetingData":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom company greeting"},"id":{"type":"string","description":"Internal identifier of a custom company greeting"}},"description":"Custom greeting data"},"CompanyAnsweringRuleCallersInfoRequest":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}},"CompanyAnsweringRuleCalledNumberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}},"IVRMenuSiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"ForwardingInfoCreateRuleRequest":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'"},"softPhonesRingCount":{"type":"integer","description":"Specifies delay between ring on apps and starting of a call forwarding"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal. Not returned for inactive numbers"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group). For inactive numbers the default value ('4') is returned"},"enabled":{"type":"boolean","description":"Phone number status"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"RecipientInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"},"CompanyAnsweringRuleScheduleInfo":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"FixedOrderAgentsExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"IVRMenuExtensionInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"PromptResource":{"type":"object","properties":{"mode":{"type":"string","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{}},"text":{"maxLength":1000,"type":"string"},"language":{"type":"object","properties":{"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"UserBusinessHoursScheduleInfo":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"},"AutomaticRecordingResource":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controling Automatic Call Recording settings"},"outboundCallTones":{"type":"boolean","description":"Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings"},"outboundCallAnnouncement":{"type":"boolean","description":"Flag for controlling 'Play periodic tones for outbound calls' settings"},"allowMute":{"type":"boolean","description":"Flag for controlling 'Allow mute in auto call recording' settings"},"extensionCount":{"type":"integer","description":"Total amount of extension that are used in call recordings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"},"maxNumberLimit":{"type":"integer","description":"Max number of automatic call recordings per account, the default value is 100 000"}}},"UserAnsweringRuleListNavigationPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"CompanyBusinessHoursScheduleInfo":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"},"CustomGreetingAnsweringRuleInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"},"UserAnsweringRuleListPaging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)","example":1},"totalPages":{"type":"integer","description":"The total number of pages in a dataset.","example":1},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied","example":100},"totalElements":{"type":"integer","description":"The total number of elements in a dataset.","example":1},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty","example":0},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty","example":0}}},"ScheduleInfo":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"SharedLinesInfo":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"},"CompanyAnsweringRuleCalledNumberInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}},"CompanyAnsweringRuleExtensionInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"CompanyAnsweringRuleTimeIntervalRequest":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}},"TimeInterval":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}},"RemovedNumberInfo":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number to be removed from the Blocked or Allowed lists"}}},"CreateSipRegistrationRequest":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Device unique identifier, retrieved at previous session (if any)"},"appExternalId":{"type":"string","description":"Supported for iOS devices only. Certificate name (used by iOS applications for APNS subscription)"},"computerName":{"type":"string","description":"Supported for SoftPhone only. Computer name"},"serial":{"type":"string","description":"Serial number for HardPhone; `endpoint_id` for softphone and mobile applications. Returned only when the phone is shipped and provisioned"}},"description":"Device information"},"sipInfo":{"type":"array","description":"SIP settings for device","items":{"type":"object","properties":{"transport":{"type":"string","description":"Supported transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]}}}}}},"CreateSipRegistrationResponse":{"required":["sipFlags","sipInfo"],"type":"object","properties":{"device":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a device resource"},"id":{"type":"string","description":"Internal identifier of a Device"},"type":{"type":"string","description":"Device type","enum":["HardPhone","SoftPhone","OtherPhone","Paging","WebPhone"]},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"status":{"type":"string","enum":["Online","Offline"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"required":["addons"],"type":"object","properties":{"id":{"type":"string","description":"Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"string","format":"int32"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Emergency response location settings of a device"},"shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]}},"description":"Phone number information"}}}},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"sipInfo":{"type":"array","description":"SIP settings for device","items":{"type":"object","properties":{"username":{"type":"string","description":"User credentials"},"password":{"type":"string","description":"User password"},"authorizationId":{"type":"string","description":"Identifier for SIP authorization"},"domain":{"type":"string","description":"SIP domain"},"outboundProxy":{"type":"string","description":"SIP outbound proxy"},"outboundProxyIPv6":{"type":"string","description":"SIP outbound IPv6 proxy"},"outboundProxyBackup":{"type":"string","description":"SIP outbound proxy backup"},"outboundProxyIPv6Backup":{"type":"string","description":"SIP outbound IPv6 proxy backup"},"transport":{"type":"string","description":"Preferred transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]},"certificate":{"type":"string","description":"For TLS transport only Base64 encoded certificate"},"switchBackInterval":{"type":"integer","description":"The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call."}}}},"sipInfoPstn":{"type":"array","description":"SIP PSTN settings for device","items":{"type":"object","properties":{"username":{"type":"string","description":"User credentials"},"password":{"type":"string","description":"User password"},"authorizationId":{"type":"string","description":"Identifier for SIP authorization"},"domain":{"type":"string","description":"SIP domain"},"outboundProxy":{"type":"string","description":"SIP outbound proxy"},"outboundProxyIPv6":{"type":"string","description":"SIP outbound IPv6 proxy"},"outboundProxyBackup":{"type":"string","description":"SIP outbound proxy backup"},"outboundProxyIPv6Backup":{"type":"string","description":"SIP outbound IPv6 proxy backup"},"transport":{"type":"string","description":"Preferred transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]},"certificate":{"type":"string","description":"For TLS transport only Base64 encoded certificate"},"switchBackInterval":{"type":"integer","description":"The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call."}}}},"sipFlags":{"type":"object","properties":{"voipFeatureEnabled":{"type":"string","description":"If 'True' VoIP calling feature is enabled","enum":["True","False"]},"voipCountryBlocked":{"type":"string","description":"If 'True' the request is sent from IP address of a country blocked for VoIP calling","enum":["True","False"]},"outboundCallsEnabled":{"type":"string","description":"If 'True' outbound calls are enabled","enum":["True","False"]},"dscpEnabled":{"type":"boolean"},"dscpSignaling":{"type":"integer"},"dscpVoice":{"type":"integer"},"dscpVideo":{"type":"integer"}},"description":"SIP flags data"},"sipErrorCodes":{"type":"array","items":{"type":"string"}}}},"HintResourceVersionUpdate":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Application version update. Returned only if the client current version is older than the latest version. 'actionRequired': 'true' means the application requires force updating to the latest version"},"OptionInfoReason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"},"ApplicationSettingsNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"DevicePhoneNumberCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"ClientResource":{"required":["detected"],"type":"object","properties":{"detected":{"type":"boolean","description":"'True', if the server succeeded detecting application info, sufficient to return provisioning info"},"userAgent":{"type":"string","description":"The value of 'User-Agent' header, as it was passed in request"},"appId":{"type":"string","description":"Application identifier (from authorization session)"},"appName":{"type":"string","description":"Application name (from authorization session, but must match 'User-Agent')"},"appKey":{"type":"string"},"appVersion":{"type":"string","description":"Application version (parsed from 'User-Agent')"},"locale":{"type":"string","description":"Locale, parsed from 'Accept-Language'. Currently en-GB and en-US locales are supported. The default value is en-US"}},"description":"Client application information"},"ProvisioningResource":{"required":["hints","webUris"],"type":"object","properties":{"interopClientIds":{"type":"object","properties":{"serviceWeb":{"type":"string"},"expressSetup":{"type":"string"},"liveReports":{"type":"string"},"qosReports":{"type":"string"},"analyticsPortal":{"type":"string","description":"Analytics Portal identifier"},"rcVideo":{"type":"string","description":"RingCentral Video client identifier"},"rcMeetings":{"type":"string","description":"RingCentral Meetings client identifier"}}},"webUris":{"type":"object","properties":{"expressSetup":{"type":"string","description":"Link to express setup page (web application)"},"expressSetupMobile":{"type":"string","description":"Link to express setup page (mobile application)"},"meetings":{"type":"string","description":"Base URL for launching the meetings"},"meetingsAppDownload":{"type":"string","description":"Link to RC Meetings application distributive package"},"meetingsRecordings":{"type":"string","description":"Base URL for sharing meetings recordings"},"mobileAppDownload":{"type":"string","description":"Link to mobile app download page"},"mobileWebBilling":{"type":"string","description":"Link to billing page (mobile application)"},"mobileWebCallHandling":{"type":"string","description":"Link to call handling page (mobile application)"},"mobileWebCallQueueManagement":{"type":"string","description":"Link to call queue management page (mobile application)"},"mobileWebChangePassword":{"type":"string","description":"Link to password change page (mobile application)"},"mobileWebInternationalCalling":{"type":"string","description":"Link to international calling page (mobile application)"},"mobileWebNotifications":{"type":"string","description":"Link to notifications page (mobile application)"},"mobileWebPhoneSystem":{"type":"string","description":"Link to phone system settings page (mobile application)"},"mobileWebQosReports":{"type":"string","description":"Link to quality of service reports page (mobile application)"},"mobileWebReporting":{"type":"string","description":"Link to reports page (mobile application)"},"mobileWebResetPassword":{"type":"string","description":"Link to reset password page (mobile application)"},"mobileWebTellAFriend":{"type":"string","description":"Link to tell-a-friend page (mobile application)"},"mobileWebTrialUpgrade":{"type":"string","description":"Link to upgrade trial account (mobile application)"},"mobileWebUserSettings":{"type":"string","description":"Link to user settings page (mobile application)"},"serviceWebBilling":{"type":"string","description":"Link to billing page (web application)"},"serviceWebBlockedCalls":{"type":"string","description":"Link to blocked calls settings section"},"serviceWebCallHandling":{"type":"string","description":"Link to call handling and forwarding settings page (web application)"},"serviceWebChangePassword":{"type":"string","description":"Link to password change page (web application)"},"serviceWebHome":{"type":"string","description":"Link to home page (web application)"},"serviceWebPhoneSystem":{"type":"string","description":"Link to phone system settings page (web application)"},"serviceWebResetPassword":{"type":"string","description":"Link to reset password page (web application)"},"serviceWebTellAFriend":{"type":"string","description":"Link to tell-a-friend page (web application)"},"serviceWebUserPhones":{"type":"string","description":"Link to user phones settings page"},"serviceWebUserSettings":{"type":"string","description":"Link to user settings page (web application)"},"signUp":{"type":"string","description":"Link to sign up page (web application)"},"support":{"type":"string","description":"Link to support page (web application)"},"webinar":{"type":"string","description":"Base URL for launching webinars"},"expiresIn":{"type":"integer","description":"Expiration time in seconds for all links with embedded hashes"},"analyticsPortal":{"type":"string","description":"Link to Analytics Portal"}},"description":"Links to the mobile web and Service Web resources"},"hints":{"type":"object","properties":{"userCredentialState":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"User credentials expiration"},"trialState":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Trial account expiration. Returned for trial accounts only"},"appVersionUpgrade":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Application version update. Returned only if the client current version is older than the latest version. 'actionRequired': 'true' means the application requires force updating to the latest version"},"nonUniqueEmail":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Specified email is not unique"},"forceUnifiedMobileApp":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Unified Mobile Application"}},"description":"Hint informing the client application on the required user action"}},"description":"Provisioning parameters. Available for the detected applications only"},"InteropClientsResource":{"type":"object","properties":{"serviceWeb":{"type":"string"},"expressSetup":{"type":"string"},"liveReports":{"type":"string"},"qosReports":{"type":"string"},"analyticsPortal":{"type":"string","description":"Analytics Portal identifier"},"rcVideo":{"type":"string","description":"RingCentral Video client identifier"},"rcMeetings":{"type":"string","description":"RingCentral Meetings client identifier"}}},"HintResourceUnifiedMobileApp":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Unified Mobile Application"},"DeviceModelInfo":{"required":["addons"],"type":"object","properties":{"id":{"type":"string","description":"Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"string","format":"int32"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"BannerInfo":{"type":"object","properties":{"bannerType":{"type":"string","description":"Type of a banner"},"description":{"type":"string","description":"Custom text description of a banner"},"content":{"type":"string","description":"HTML formatted message content"},"expirationDate":{"type":"string","description":"Datetime of message expiration in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z"}}},"WebUrisResource":{"type":"object","properties":{"expressSetup":{"type":"string","description":"Link to express setup page (web application)"},"expressSetupMobile":{"type":"string","description":"Link to express setup page (mobile application)"},"meetings":{"type":"string","description":"Base URL for launching the meetings"},"meetingsAppDownload":{"type":"string","description":"Link to RC Meetings application distributive package"},"meetingsRecordings":{"type":"string","description":"Base URL for sharing meetings recordings"},"mobileAppDownload":{"type":"string","description":"Link to mobile app download page"},"mobileWebBilling":{"type":"string","description":"Link to billing page (mobile application)"},"mobileWebCallHandling":{"type":"string","description":"Link to call handling page (mobile application)"},"mobileWebCallQueueManagement":{"type":"string","description":"Link to call queue management page (mobile application)"},"mobileWebChangePassword":{"type":"string","description":"Link to password change page (mobile application)"},"mobileWebInternationalCalling":{"type":"string","description":"Link to international calling page (mobile application)"},"mobileWebNotifications":{"type":"string","description":"Link to notifications page (mobile application)"},"mobileWebPhoneSystem":{"type":"string","description":"Link to phone system settings page (mobile application)"},"mobileWebQosReports":{"type":"string","description":"Link to quality of service reports page (mobile application)"},"mobileWebReporting":{"type":"string","description":"Link to reports page (mobile application)"},"mobileWebResetPassword":{"type":"string","description":"Link to reset password page (mobile application)"},"mobileWebTellAFriend":{"type":"string","description":"Link to tell-a-friend page (mobile application)"},"mobileWebTrialUpgrade":{"type":"string","description":"Link to upgrade trial account (mobile application)"},"mobileWebUserSettings":{"type":"string","description":"Link to user settings page (mobile application)"},"serviceWebBilling":{"type":"string","description":"Link to billing page (web application)"},"serviceWebBlockedCalls":{"type":"string","description":"Link to blocked calls settings section"},"serviceWebCallHandling":{"type":"string","description":"Link to call handling and forwarding settings page (web application)"},"serviceWebChangePassword":{"type":"string","description":"Link to password change page (web application)"},"serviceWebHome":{"type":"string","description":"Link to home page (web application)"},"serviceWebPhoneSystem":{"type":"string","description":"Link to phone system settings page (web application)"},"serviceWebResetPassword":{"type":"string","description":"Link to reset password page (web application)"},"serviceWebTellAFriend":{"type":"string","description":"Link to tell-a-friend page (web application)"},"serviceWebUserPhones":{"type":"string","description":"Link to user phones settings page"},"serviceWebUserSettings":{"type":"string","description":"Link to user settings page (web application)"},"signUp":{"type":"string","description":"Link to sign up page (web application)"},"support":{"type":"string","description":"Link to support page (web application)"},"webinar":{"type":"string","description":"Base URL for launching webinars"},"expiresIn":{"type":"integer","description":"Expiration time in seconds for all links with embedded hashes"},"analyticsPortal":{"type":"string","description":"Link to Analytics Portal"}},"description":"Links to the mobile web and Service Web resources"},"SIPFlagsResponse":{"type":"object","properties":{"voipFeatureEnabled":{"type":"string","description":"If 'True' VoIP calling feature is enabled","enum":["True","False"]},"voipCountryBlocked":{"type":"string","description":"If 'True' the request is sent from IP address of a country blocked for VoIP calling","enum":["True","False"]},"outboundCallsEnabled":{"type":"string","description":"If 'True' outbound calls are enabled","enum":["True","False"]},"dscpEnabled":{"type":"boolean"},"dscpSignaling":{"type":"integer"},"dscpVoice":{"type":"integer"},"dscpVideo":{"type":"integer"}},"description":"SIP flags data"},"SipRegistrationDeviceEmergencyInfo":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Emergency response location settings of a device"},"Shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"OptionInfoRingOut":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"RingOut call"},"ApplicationSettingsNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"DevicePhoneLinesEmergencyAddressInfo":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"DevicePhoneNumberInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]}},"description":"Phone number information"},"DevicePhoneLinesInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]}},"description":"Phone number information"}}},"SipRegistrationDeviceLocationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Company emergency response location details"},"DeviceAddonInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"string","format":"int32"}}},"SpecialNumberFeaturesInfo":{"type":"object","properties":{"voip":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"VoIP call"},"ringOut":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"RingOut call"},"sms":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"Outgoing SMS"},"faxOut":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"Outgoing Fax"}},"description":"Information on options allowed/disallowed for the special number"},"HintResourceUserCredentilals":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"User credentials expiration"},"SipRegistrationDeviceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a device resource"},"id":{"type":"string","description":"Internal identifier of a Device"},"type":{"type":"string","description":"Device type","enum":["HardPhone","SoftPhone","OtherPhone","Paging","WebPhone"]},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"status":{"type":"string","enum":["Online","Offline"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"required":["addons"],"type":"object","properties":{"id":{"type":"string","description":"Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"string","format":"int32"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Emergency response location settings of a device"},"shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]}},"description":"Phone number information"}}}},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"SIPInfoResponse":{"type":"object","properties":{"username":{"type":"string","description":"User credentials"},"password":{"type":"string","description":"User password"},"authorizationId":{"type":"string","description":"Identifier for SIP authorization"},"domain":{"type":"string","description":"SIP domain"},"outboundProxy":{"type":"string","description":"SIP outbound proxy"},"outboundProxyIPv6":{"type":"string","description":"SIP outbound IPv6 proxy"},"outboundProxyBackup":{"type":"string","description":"SIP outbound proxy backup"},"outboundProxyIPv6Backup":{"type":"string","description":"SIP outbound IPv6 proxy backup"},"transport":{"type":"string","description":"Preferred transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]},"certificate":{"type":"string","description":"For TLS transport only Base64 encoded certificate"},"switchBackInterval":{"type":"integer","description":"The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call."}}},"OptionInfoFaxOut":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"Outgoing Fax"},"HintsResource":{"type":"object","properties":{"userCredentialState":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"User credentials expiration"},"trialState":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Trial account expiration. Returned for trial accounts only"},"appVersionUpgrade":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Application version update. Returned only if the client current version is older than the latest version. 'actionRequired': 'true' means the application requires force updating to the latest version"},"nonUniqueEmail":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Specified email is not unique"},"forceUnifiedMobileApp":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Unified Mobile Application"}},"description":"Hint informing the client application on the required user action"},"DeviceEmergencyServiceAddressResource":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"OptionInfoVoIP":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"VoIP call"},"HintResourceTrialState":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Trial account expiration. Returned for trial accounts only"},"DeviceExtensionInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"OptionInfoSMSOut":{"required":["reason"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the feature is allowed ('True') or disallowed ('False') for the special number"},"reason":{"type":"object","properties":{"id":{"type":"string","description":"Internal code of the option disallowance reason"},"message":{"type":"string","description":"Text description of the option disallowance reason"}},"description":"The reason explaining why the option is disallowed. Returned if the value of enabled is 'False'"}},"description":"Outgoing SMS"},"SIPInfoRequest":{"type":"object","properties":{"transport":{"type":"string","description":"Supported transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]}}},"MethodResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"HintResourceNonUniqueEmail":{"type":"object","properties":{"expiresIn":{"type":"integer","description":"Seconds until expiration date. Returned only if applicable"},"actionRequired":{"type":"boolean","description":"'False', if the value of expiresIn is greater than 0 (zero), otherwise - 'True'"},"messageUri":{"type":"string"}},"description":"Specified email is not unique"},"DeviceSiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"ApplicationSettingsPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"DeviceInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Device unique identifier, retrieved at previous session (if any)"},"appExternalId":{"type":"string","description":"Supported for iOS devices only. Certificate name (used by iOS applications for APNS subscription)"},"computerName":{"type":"string","description":"Supported for SoftPhone only. Computer name"},"serial":{"type":"string","description":"Serial number for HardPhone; `endpoint_id` for softphone and mobile applications. Returned only when the phone is shipped and provisioned"}},"description":"Device information"},"AttachmentInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"contentType":{"type":"string"}}},"GetExtensionGrantListResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of extension grants"},"records":{"type":"array","description":"List of extension grants with details","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a grant"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits)"},"name":{"type":"string","description":"Name of extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation"]}},"description":"Extension information"},"callPickup":{"type":"boolean","description":"Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned"},"callMonitoring":{"type":"boolean","description":"Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned"},"callOnBehalfOf":{"type":"boolean","description":"Specifies whether the current extension is able to make or receive calls on behalf of the user referenced in extension object"},"callDelegation":{"type":"boolean","description":"Specifies whether the current extension can delegate a call to the user referenced in extension object"},"groupPaging":{"type":"boolean","description":"Specifies whether the current extension is allowed to call Paging Only group referenced to in extension object"},"callQueueSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Full-Access manager in the call queue referenced in extension object"},"callQueueMembersSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Members-Only manager in the call queue referenced in extension object"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"UpdateWirelessPoint":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. Mask: XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"SwitchesList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the switches list resource"},"records":{"type":"array","description":"Switches map","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallQueues":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queues resource"},"records":{"type":"array","description":"List of call queues","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateNetworkRequest":{"type":"object","properties":{"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"UpdateMultipleSwitchesRequest":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}},"ValidateMultipleWirelessPointsRequest":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}}}},"GetCountryInfoDictionaryResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"},"numberSelling":{"type":"boolean","description":"Determines whether phone numbers are available for a country"},"loginAllowed":{"type":"boolean","description":"Specifies whether login with the phone numbers of this country is enabled or not"},"signupAllowed":{"type":"boolean","description":"Indicates whether signup/billing is allowed for a country"},"freeSoftphoneLine":{"type":"boolean","description":"Specifies if free phone line for softphone is available for a country or not"}}},"UserVideoConfiguration":{"type":"object","properties":{"provider":{"type":"string","description":"Video provider of the user","enum":["RCMeetings","RCVideo","None"]},"userLicenseType":{"type":"string","description":"Specifies if the user is 'paid' (has meeting license) or 'free' (w/o meeting license)","enum":["Paid","Free"]}}},"PagingOnlyGroupDevices":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of devices assigned to the paging only group"},"records":{"type":"array","description":"List of paging devices assigned to this group","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging device"},"uri":{"type":"string","description":"Link to a paging device resource"},"name":{"type":"string","description":"Name of a paging device"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"WirelessPointsList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point list resource"},"records":{"type":"array","description":"List of wireless points with assigned emergency addresses","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"NetworksList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a networks resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a network"},"uri":{"type":"string","description":"Link to a network resource"},"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"NetworkInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a network"},"uri":{"type":"string","description":"Link to a network resource"},"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"UpdateMultipleWirelessPointsRequest":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. Mask: XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}},"ValidateMultipleSwitchesResponse":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}}}}},"DepartmentMemberList":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"uri":{"type":"string","description":"Link to the list of department members"},"records":{"type":"array","description":"List of department members extensions","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallMonitoringGroupMemberList":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group members resource"},"records":{"type":"array","description":"List of a call monitoring group members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group member"},"id":{"type":"string","description":"Internal identifier of a call monitoring group member"},"extensionNumber":{"type":"string","description":"Extension number of a call monitoring group member"},"permissions":{"type":"array","items":{"type":"string","description":"Call monitoring permission; mltiple values are allowed: * `Monitoring` - User can monitor a group * `Monitored` - User can be monitored\n","enum":["Monitoring","Monitored"]}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"EmergencyLocationInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}}},"UpdateConferencingInfoRequest":{"type":"object","properties":{"phoneNumbers":{"type":"array","description":"Multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"}}}},"allowJoinBeforeHost":{"type":"boolean","description":"Determines if host user allows conference participants to join before the host"}}},"ModifyAccountBusinessAddressRequest":{"type":"object","properties":{"company":{"type":"string","description":"Company business name"},"email":{"type":"string","description":"Company business email address"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Name of a country"},"state":{"type":"string","description":"Name of a state/province"},"city":{"type":"string","description":"Name of a city"},"street":{"type":"string","description":"Street address"},"zip":{"type":"string","description":"Zip code"}},"description":"Company business address"},"mainSiteName":{"type":"string","description":"Custom site name"}}},"GetTimezoneInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Description of a timezone"},"bias":{"type":"string"}}},"AddressBookBulkUploadRequest":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of extensions which contacts have to be updated","items":{"required":["extensionId","contacts"],"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contacts":{"type":"array","description":"List of contacts to be added to extension address book","items":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}}}}}}}},"ListDevicesAutomaticLocationUpdates":{"type":"object","properties":{"uri":{"type":"string","description":"Link to devices resource"},"records":{"type":"array","description":"List of users' devices with the current status of Emergency Address Auto Update Feature","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["HardPhone","SoftPhone","OtherPhone"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned)"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"name":{"type":"string","description":"Device name"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Device model identifier"},"name":{"type":"string","description":"Device name"},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"phoneNumber":{"type":"string","description":"Phone number"}}}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"SwitchInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"EmergencyLocationList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"LanguageList":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the language list resource"},"records":{"type":"array","description":"Language data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"ExtensionGrantListEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"AccountBusinessAddressResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"company":{"type":"string"},"email":{"type":"string"},"mainSiteName":{"type":"string","description":"Custom site name"}}},"GetLocationListResponse":{"required":["navigation","paging"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the location list resource"},"records":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a location"},"areaCode":{"type":"string","description":"Area code of the location"},"city":{"type":"string","description":"Official name of the city, belonging to the certain state"},"npa":{"type":"string","description":"Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"nxx":{"type":"string","description":"Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"state":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Link to a state resource"}},"description":"Information on the state this location belongs to"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateSwitchInfo":{"required":["chassisId"],"type":"object","properties":{"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"UpdateMultipleSwitchesResponse":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple switches update"}}},"ValidateMultipleWirelessPointsResponse":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}}}}},"GetConferencingInfoResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a conferencing"},"allowJoinBeforeHost":{"type":"boolean","description":"Determines if host user allows conference participants to join before the host"},"hostCode":{"type":"string","description":"Access code for a host user"},"mode":{"type":"string","description":"Internal parameter specifying conferencing engine"},"participantCode":{"type":"string","description":"Access code for any participant"},"phoneNumber":{"type":"string","description":"Primary conference phone number for user's home country returned in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"tapToJoinUri":{"type":"string","description":"Short URL leading to the service web page Tap to Join for audio conference bridge"},"phoneNumbers":{"type":"array","description":"List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic","items":{"type":"object","properties":{"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a home country of a conference phone number"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"},"hasGreeting":{"type":"boolean","description":"'True' if the greeting message is played on this number"},"location":{"type":"string","description":"Location (city, region, state) of a conference phone number"},"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"premium":{"type":"boolean","description":"Indicates if the number is 'premium' (account phone number with the `ConferencingNumber` usageType)"}}}}}},"UserTemplates":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to user templates resource"},"records":{"type":"array","description":"List of user templates","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a template"},"id":{"type":"string","description":"Internal identifier of a template"},"type":{"type":"string","enum":["UserSettings","CallHandling"]},"name":{"type":"string","description":"Name of a template"},"creationTime":{"type":"string","description":"Time of a template creation"},"lastModifiedTime":{"type":"string","description":"Time of the last template modification"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"FeatureList":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a feature"},"available":{"type":"boolean","description":"Specifies if the feature is available for the current user according to services enabled for the account, type, entitlements and permissions of the extension. If the authorized user gets features of the other extension, only features that can be delegated are returned (such as configuration by administrators)."},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}}},"reason":{"type":"object","properties":{"code":{"type":"string","description":"Reason code","enum":["ServicePlanLimitation","AccountLimitation","ExtensionTypeLimitation","ExtensionLimitation","InsufficientPermissions","ConfigurationLimitation"]},"message":{"type":"string","description":"Reason description"},"permission":{"type":"string"}},"description":"Reason for the feature unavailability. Returned only if `available` is set to 'false'"}}}}}},"ExtensionBulkUpdateRequest":{"required":["records"],"description":"List of extensions to be updated","type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","enum":["Disabled","Enabled","NotActivated","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"reason":{"type":"string","description":"Type of suspension"},"comment":{"type":"string","description":"Free form user comment"},"extensionNumber":{"type":"string","description":"Extension number available"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed"]},"partnerId":{"type":"string","description":"Additional extension identifier created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"password":{"type":"string","description":"Password for extension"},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"transition":{"type":"object","items":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","DelegatedLinesGroup"]},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}}}}}}},"GetExtensionInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"account":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"}},"description":"Account information"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"departments":{"type":"array","description":"Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","items":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"id":{"type":"string","description":"Internal identifier of a department extension"},"uri":{"type":"string","description":"Canonical URI of a department extension"},"extensionNumber":{"type":"string","description":"Number of a department extension"}}}},"extensionNumber":{"type":"string","description":"Number of extension"},"extensionNumbers":{"type":"array","items":{"type":"string"}},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"serviceFeatures":{"type":"array","description":"Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features","items":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}}},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup).","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}},"CreateWirelessPoint":{"required":["bssid","emergencyAddress","name"],"type":"object","properties":{"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. The Mask is XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"UpdateNetworkRequest":{"type":"object","properties":{"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"AssignMultipleDevicesAutomaticLocationUpdates":{"type":"object","properties":{"enabledDeviceIds":{"type":"array","items":{"type":"string","description":"List of common devices for feature activation"}},"disabledDeviceIds":{"type":"array","items":{"type":"string","description":"List of common devices for feature disabling"}}}},"CreateMultipleWirelessPointsRequest":{"type":"object","properties":{"records":{"type":"array","items":{"required":["bssid","emergencyAddress","name"],"type":"object","properties":{"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. The Mask is XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}},"UserEmergencyLocationList":{"type":"object","properties":{"id":{"type":"string"}}},"CallMonitoringGroup":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group resource"},"id":{"type":"string","description":"Internal identifier of a group"},"name":{"type":"string","description":"Name of a group"}}},"ExtensionCallerIdInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URL of a caller ID resource"},"byDevice":{"type":"array","items":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by device"}},"byFeature":{"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","enum":["RingOut","RingMe","CallFlip","FaxNumber","AdditionalSoftphone","Alternate","CommonPhone","MobileApp","Delegated"]},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by feature"}},"extensionNameForOutboundCalls":{"type":"boolean","description":"If 'True', then user first name and last name will be used as caller ID when making outbound calls from extension"},"extensionNumberForInternalCalls":{"type":"boolean","description":"If 'True', then extension number will be used as caller ID when making internal calls"}}},"WirelessPointInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}},"NotificationSettings":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of notifications settings resource"},"emailRecipients":{"type":"array","description":"List of extensions specified as email notification recipients. Returned only for call queues where queue managers are assigned as user extensions.","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"fullName":{"type":"string","description":"User full name"},"extensionNumber":{"type":"string","description":"User extension number"},"status":{"type":"string","description":"Current state of an extension","enum":["Enabled","Disable","NotActivated","Unassigned"]},"emailAddresses":{"type":"array","description":"List of user email addresses from extension notification settings. By default main email address from contact information is returned","items":{"type":"string"}},"permission":{"type":"string","description":"Call queue manager permission","enum":["FullAccess","MembersOnly"]}}}},"emailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"smsEmailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"advancedMode":{"type":"boolean","description":"Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied "},"voicemails":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"inboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"outboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"inboundTexts":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"missedCalls":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}}}},"GetCountryListResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of countries supported"},"records":{"type":"array","description":"List of countries with the country data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"},"numberSelling":{"type":"boolean","description":"Determines whether phone numbers are available for a country"},"loginAllowed":{"type":"boolean","description":"Specifies whether login with the phone numbers of this country is enabled or not"},"signupAllowed":{"type":"boolean","description":"Indicates whether signup/billing is allowed for a country"},"freeSoftphoneLine":{"type":"boolean","description":"Specifies if free phone line for softphone is available for a country or not"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallMonitoringGroups":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring groups resource"},"records":{"type":"array","description":"List of call monitoring group members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group resource"},"id":{"type":"string","description":"Internal identifier of a group"},"name":{"type":"string","description":"Name of a group"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"UserCallQueues":{"type":"object","properties":{"records":{"type":"array","description":"List of the queues where the extension is an agent","items":{"type":"object","properties":{"id":{"type":"string","description":"Call queue extension identifier"},"name":{"type":"string","description":"Call queue name (read-only)"}}}}}},"GetExtensionPhoneNumbersResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the user's phone number list resource"},"records":{"type":"array","description":"List of phone numbers","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the user's phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"features":{"type":"array","description":"List of features of a phone number","items":{"type":"string","enum":["CallerId","SmsSender","A2PSmsSender","MmsSender","InternationalSmsSender","Delegated"]}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateMultipleSwitchesRequest":{"type":"object","properties":{"records":{"type":"array","items":{"required":["chassisId"],"type":"object","properties":{"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}},"CreateMultipleWirelessPointsResponse":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points creation"}}},"GetTimezoneListResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the timezone list resource"},"records":{"type":"array","description":"List of timezones","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Description of a timezone"},"bias":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"AccountPhoneNumbers":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of account phone numbers"},"records":{"type":"array","description":"List of account phone numbers","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a company phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","MeetingsNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"temporaryNumber":{"type":"object","properties":{"id":{"type":"string","description":"Temporary phone number identifier"},"phoneNumber":{"type":"string","description":"Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}},"description":"Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"vanityPattern":{"type":"string","description":"Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallQueueUpdateDetails":{"type":"object","properties":{"serviceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"editableMemberStatus":{"type":"boolean","description":"Allows members to change their queue status"}}},"CallQueueMembers":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queue members resource"},"records":{"type":"array","description":"List of call queue members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queue member"},"id":{"type":"integer","description":"Internal identifier of a call queue member"},"extensionNumber":{"type":"string","description":"Extension number of a call queue member"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CallMonitoringBulkAssign":{"type":"object","properties":{"addedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}},"updatedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}},"removedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}}}},"AddressBookBulkUploadResponse":{"description":"Information on a task for adding multiple contacts to multiple extensions","required":["id","uri","creationTime","lastModifiedTime","status"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"uri":{"type":"string","description":"Link for the task status retrieval"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Datetime of a task creation"},"lastModifiedTime":{"type":"string","description":"Datetime of a task latest update"},"results":{"type":"object","description":"Result record on adding multiple contacts to an extension. Returned for completed tasks","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contact":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}},"status":{"type":"string","description":"Adding contact status","enum":["Success","Fail"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}},"ExtensionInfoEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Update","Delete"]},"hints":{"type":"array","description":"Returned for 'Update' event type only","items":{"type":"string","enum":["AccountSettings","AccountStatus","AnsweringRules","CompanyNumbers","DialingPlan","ExtensionInfo","Features","Limits","Permissions","ProfileImage","VideoConfiguration"]}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"ValidateMultipleSwitchesRequest":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}},"GetAccountInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"},"bsid":{"type":"string","description":"Internal identifier of an account in the billing system"},"mainNumber":{"type":"string","description":"Main phone number of the current account"},"operator":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an operator extension resource"},"id":{"type":"integer","description":"Internal identifier of an operator extension"},"extensionNumber":{"type":"string","description":"Number of an operator extension"}},"description":"Operator's extension information. This extension will receive all calls and messages intended for the operator."},"partnerId":{"type":"string","description":"Additional account identifier, created by partner application and applied on client side"},"serviceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a service info resource"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"}},"description":"Account service information, including brand, service plan and billing plan"},"setupWizardState":{"type":"string","description":"Specifies account configuration wizard state (web service setup)","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"signupInfo":{"type":"object","properties":{"tosAccepted":{"type":"boolean","default":false},"signupState":{"type":"array","items":{"type":"string","enum":["AccountCreated","BillingEntered","CreditCardApproved","AccountConfirmed","PhoneVerificationRequired","PhoneVerificationPassed"]}},"verificationReason":{"type":"string","enum":["CC_Failed","Phone_Suspicious","CC_Phone_Not_Match","AVS_Not_Available","MaxMind","CC_Blacklisted","Email_Blacklisted","Phone_Blacklisted","Cookie_Blacklisted","Device_Blacklisted","IP_Blacklisted","Agent_Instance_Blacklisted","Charge_Limit","Other_Country","Unknown"]},"marketingAccepted":{"type":"boolean","description":"Updates 'Send Marketing Information' flag on web interface"}},"description":"Account sign up data"},"status":{"type":"string","description":"Status of the current account","enum":["Initial","Confirmed","Unconfirmed","Disabled"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["SuspendedVoluntarily","SuspendedInvoluntarily","UserResumed"]},"till":{"type":"string","description":"Date until which the account will get deleted. The default value is 30 days since current date"}},"description":"Status information (reason, comment, lifetime). Returned for 'Disabled' status only"},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]},"currency":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a currency"},"code":{"type":"string","description":"Official code of a currency"},"name":{"type":"string","description":"Official name of a currency"},"symbol":{"type":"string","description":"Graphic symbol of a currency"},"minorSymbol":{"type":"string","description":"Minor graphic symbol of a currency"}},"description":"Currency information"}},"description":"Account level region data (web service Auto-Receptionist settings)"},"federated":{"type":"boolean","description":"Specifies whether an account is included into any federation of accounts or not"},"outboundCallPrefix":{"type":"integer","description":"If outbound call prefix is not specified, or set to null (0), then the parameter is not returned; the supported value range is 2-9"},"cfid":{"type":"string","description":"Customer facing identifier. Returned for accounts with the turned off PBX features. Equals to main company number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (without '+' sign)format "},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"}}},"ExtensionCreationResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"serviceFeatures":{"type":"array","description":"Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features","items":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}}},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted'","enum":["NotStarted","Incomplete","Completed"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","Limited"]},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"}}},"CallQueueBulkAssignResource":{"type":"object","properties":{"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}},"DepartmentBulkAssignResource":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"items":{"type":"array","items":{"type":"object","properties":{"departmentId":{"type":"string"},"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}}}}},"AutomaticLocationUpdatesTaskInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"},"type":{"type":"string","description":"Type of a task","enum":["WirelessPointsBulkCreate","WirelessPointsBulkUpdate","SwitchesBulkCreate","SwitchesBulkUpdate"]},"result":{"type":"object","properties":{"records":{"type":"array","description":"Detailed task results by elements from initial request","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the created/updated element - wireless point or network switch"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions. Returned only for 'Wireless Points Bulk Create' tasks"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. Returned only for 'Switches Bulk Create' tasks"},"status":{"type":"string","description":"Operation status"},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"parameterName":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Task detailed result. Returned for failed and completed tasks"}}},"GetStateListResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the states list resource"},"records":{"type":"array","description":"List of states","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"}},"description":"Information on a country the state belongs to"},"isoCode":{"type":"string","description":"Short code for a state (2-letter usually)"},"name":{"type":"string","description":"Official name of a state"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"GetExtensionListResponse":{"required":["records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the extension list resource"},"records":{"type":"array","description":"List of extensions with extension information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"TemplateInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a template"},"id":{"type":"string","description":"Internal identifier of a template"},"type":{"type":"string","enum":["UserSettings","CallHandling"]},"name":{"type":"string","description":"Name of a template"},"creationTime":{"type":"string","description":"Time of a template creation"},"lastModifiedTime":{"type":"string","description":"Time of the last template modification"}}},"ExtensionUpdateRequest":{"type":"object","properties":{"status":{"type":"string","enum":["Disabled","Enabled","NotActivated","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"reason":{"type":"string","description":"Type of suspension"},"comment":{"type":"string","description":"Free Form user comment"},"extensionNumber":{"type":"string","description":"Extension number available"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed"]},"partnerId":{"type":"string","description":"Additional extension identifier, created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"password":{"type":"string","description":"Password for extension"},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"transition":{"type":"object","items":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","DelegatedLinesGroup","GroupCallPickup"]},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}}}},"UpdateMultipleWirelessPointsResponse":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points update"}}},"GetLocationDeletionMultiResponse":{"type":"object","properties":{"deletion":{"type":"string","enum":["Forbidden","Restricted","Allowed"]},"reassignment":{"type":"string","enum":["Forbidden","Allowed"]},"emergencyLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"deletion":{"type":"string","description":"Identifies the possibility and status of emergency location deletion","enum":["Failed","Completed","Forbidden","Restricted","Allowed"]},"errors":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"additionalInfo":{"type":"string","description":"Additional attribute for this error, for example `parameterName`"}}}}}}}},"GetStateInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"}},"description":"Information on a country the state belongs to"},"isoCode":{"type":"string","description":"Short code for a state (2-letter usually)"},"name":{"type":"string","description":"Official name of a state"}}},"CompanyPhoneNumberInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a company phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","MeetingsNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"temporaryNumber":{"type":"object","properties":{"id":{"type":"string","description":"Temporary phone number identifier"},"phoneNumber":{"type":"string","description":"Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}},"description":"Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"vanityPattern":{"type":"string","description":"Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern"}}},"AutomaticLocationUpdatesUserList":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the users list resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"fullName":{"type":"string","description":"User name"},"extensionNumber":{"type":"string"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"type":{"type":"string","description":"User extension type","enum":["User","Limited"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"department":{"type":"string","description":"Department name"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateMultipleSwitchesResponse":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple switches update"}},"description":"Information on the task for multiple switches creation"},"NotificationSettingsUpdateRequest":{"type":"object","properties":{"emailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"smsEmailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"advancedMode":{"type":"boolean","description":"Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied "},"voicemails":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"inboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"outboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"inboundTexts":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"missedCalls":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}}}},"GetServiceInfoResponse":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the account Service Info resource"},"servicePlanName":{"type":"string","description":"Account Service Plan name"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"serviceFeatures":{"type":"array","description":"Service features information, see Service Feature List","items":{"type":"object","properties":{"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"enabled":{"type":"boolean","description":"Feature status, shows feature availability for the extension"}}}},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"},"package":{"type":"object","properties":{"version":{"type":"string","description":"Billing package version"},"id":{"type":"string","description":"Billing package identifier"}}}}},"LanguageInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"EditPagingGroupRequest":{"type":"object","properties":{"addedUserIds":{"type":"array","description":"List of users that will be allowed to page a group specified","items":{"type":"string"}},"removedUserIds":{"type":"array","description":"List of users that will be unallowed to page a group specified","items":{"type":"string"}},"addedDeviceIds":{"type":"array","description":"List of account devices that will be assigned to a paging group specified","items":{"type":"string"}},"removedDeviceIds":{"type":"array","description":"List of account devices that will be unassigned from a paging group specified","items":{"type":"string"}}}},"UpdateSwitchInfo":{"type":"object","properties":{"id":{"type":"string","description":"internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}},"ExtensionListEvent":{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Create","Update","Delete"]},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},"ExtensionCreationRequest":{"type":"object","properties":{"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact Information"},"extensionNumber":{"type":"string","description":"Number of extension"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"password":{"type":"string","description":"Password for extension. If not specified, the password is auto-generated"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"partnerId":{"type":"string","description":"Additional extension identifier, created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup).","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Extension user first name"},"extensionNumber":{"type":"string","description":"Extension number"},"callerIdName":{"type":"string","description":"Custom name of a caller. Max number of characters is 15 (only alphabetical symbols, numbers and commas are supported)"},"email":{"type":"string","description":"Exetnsion user email"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"operator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an operator"},"uri":{"type":"string","description":"Link to an operator resource"},"extensionNumber":{"type":"string","description":"Extension number (pin)"},"name":{"type":"string","description":"Operator extension user full name"}},"description":"Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled"},"code":{"type":"string","description":"Site code value. Returned only if specified"}}},"status":{"type":"string","description":"Extension current state","enum":["Enabled","Disabled","NotActivated","Unassigned","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","Limited"]},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only. For unassigned extensions the value is set to 'True' by default. For assigned extensions the value is set to 'False' by default"}}},"CallQueueDetails":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Call queue name"},"extensionNumber":{"type":"string","description":"Call queue extension number"},"status":{"type":"string","description":"Call queue status","enum":["Enabled","Disabled","NotActivated"]},"serviceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"editableMemberStatus":{"type":"boolean","description":"Allows members to change their queue status"}}},"PagingOnlyGroupUsers":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of users allowed to page the Paging Only group"},"records":{"type":"array","description":"List of users allowed to page the Paging Only group","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging group user extension"},"uri":{"type":"string","description":"Link to a paging group user extension"},"extensionNumber":{"type":"string","description":"Extension number of a paging group user"},"name":{"type":"string","description":"Name of a paging group user"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"CreateCallMonitoringGroupRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of a group"}}},"BulkAssignAutomaticLocationUpdatesUsers":{"type":"object","properties":{"enabledUserIds":{"type":"array","items":{"type":"string"}},"disabledUserIds":{"type":"array","items":{"type":"string"}}}},"EmergencyLocationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"},"ExtensionBulkUpdateTaskResource":{"required":["creationTime","id","lastModifiedTime","status","uri"],"type":"object","description":"Information on a task for updating multiple extensions","properties":{"uri":{"type":"string","description":"Link to a task resource"},"id":{"type":"string","description":"Internal identifier of a task"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task latest update datetime"},"result":{"type":"object","description":"Result record on multiple extension update task","properties":{"affectedItems":{"type":"array","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","description":"Extension update status","enum":["Fail","Success"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}},"SwitchSiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"DepartmentInfo":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"id":{"type":"string","description":"Internal identifier of a department extension"},"uri":{"type":"string","description":"Canonical URI of a department extension"},"extensionNumber":{"type":"string","description":"Number of a department extension"}}},"CallerIdDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"PhoneNumberInfoConferencing":{"type":"object","properties":{"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a home country of a conference phone number"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"},"hasGreeting":{"type":"boolean","description":"'True' if the greeting message is played on this number"},"location":{"type":"string","description":"Location (city, region, state) of a conference phone number"},"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"premium":{"type":"boolean","description":"Indicates if the number is 'premium' (account phone number with the `ConferencingNumber` usageType)"}}},"TrialInfo":{"type":"object","properties":{"upgradePackage":{"type":"object","properties":{"version":{"type":"string","description":"Upgrade package version"},"id":{"type":"string","description":"Updgrade package identifier"}},"description":"Target package to be used on trial account upgrade"},"durationUnit":{"type":"string","description":"Duration period","enum":["Month","Day"]},"duration":{"type":"integer","description":"Number of duration units"}}},"ExtensionInfoProvisionPhoneNumbers":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"partnerId":{"type":"string","description":"For partner applications. Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on extension which the phone number is added to, only for provisioning extension-level numbers"},"Permission":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"ExtensionGrantListEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"ExtensionBulkUpdateTaskResult":{"type":"object","description":"Result record on multiple extension update task","properties":{"affectedItems":{"type":"array","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","description":"Extension update status","enum":["Fail","Success"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}},"CustomFieldInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}},"BrandInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"GetDialingPlanCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}}},"PrivateIpRangeInfoRequest":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}},"AddressBookBulkUploadTaskResult":{"type":"object","description":"Result record on adding multiple contacts to an extension. Returned for completed tasks","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contact":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}},"status":{"type":"string","description":"Adding contact status","enum":["Success","Fail"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}},"TemporaryNumberInfo":{"type":"object","properties":{"id":{"type":"string","description":"Temporary phone number identifier"},"phoneNumber":{"type":"string","description":"Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}},"description":"Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only"},"AutomaticLocationUpdatesSiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"CallQueueInfoRequest":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"ExtensionTimezoneInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"SiteIVRActionsExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"name":{"type":"string","description":"Name of an extension user"}},"description":"Extension information"},"ReasonInfo":{"type":"object","properties":{"code":{"type":"string","description":"Reason code","enum":["ServicePlanLimitation","AccountLimitation","ExtensionTypeLimitation","ExtensionLimitation","InsufficientPermissions","ConfigurationLimitation"]},"message":{"type":"string","description":"Reason description"},"permission":{"type":"string"}},"description":"Reason for the feature unavailability. Returned only if `available` is set to 'false'"},"PronouncedNameInfo":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"OutboundFaxesInfo":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"SignupInfoResource":{"type":"object","properties":{"tosAccepted":{"type":"boolean","default":false},"signupState":{"type":"array","items":{"type":"string","enum":["AccountCreated","BillingEntered","CreditCardApproved","AccountConfirmed","PhoneVerificationRequired","PhoneVerificationPassed"]}},"verificationReason":{"type":"string","enum":["CC_Failed","Phone_Suspicious","CC_Phone_Not_Match","AVS_Not_Available","MaxMind","CC_Blacklisted","Email_Blacklisted","Phone_Blacklisted","Cookie_Blacklisted","Device_Blacklisted","IP_Blacklisted","Agent_Instance_Blacklisted","Charge_Limit","Other_Country","Unknown"]},"marketingAccepted":{"type":"boolean","description":"Updates 'Send Marketing Information' flag on web interface"}},"description":"Account sign up data"},"AccountStatusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["SuspendedVoluntarily","SuspendedInvoluntarily","UserResumed"]},"till":{"type":"string","description":"Date until which the account will get deleted. The default value is 30 days since current date"}},"description":"Status information (reason, comment, lifetime). Returned for 'Disabled' status only"},"AccountRegionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]},"currency":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a currency"},"code":{"type":"string","description":"Official code of a currency"},"name":{"type":"string","description":"Official name of a currency"},"symbol":{"type":"string","description":"Graphic symbol of a currency"},"minorSymbol":{"type":"string","description":"Minor graphic symbol of a currency"}},"description":"Currency information"}},"description":"Account level region data (web service Auto-Receptionist settings)"},"TargetServicePlanInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"ServicePlan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"edition":{"type":"string","enum":["Unknown","Standard","Premium","Enterprise","Unlimited","HighUsage"]}}},"PublicIpRangeInfo":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}},"ExtensionInfoEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Update","Delete"]},"hints":{"type":"array","description":"Returned for 'Update' event type only","items":{"type":"string","enum":["AccountSettings","AccountStatus","AnsweringRules","CompanyNumbers","DialingPlan","ExtensionInfo","Features","Limits","Permissions","ProfileImage","VideoConfiguration"]}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"SoftPhoneLocationAutoUpdateInfo":{"type":"object","properties":{"status":{"type":"string","description":"Feature (Automatic Location Updates) activation status for softphones","enum":["Active","Inactive","Unavailable"]}}},"ReferenceInfo":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}},"RegionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"CurrencyInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a currency"},"code":{"type":"string","description":"Official code of a currency"},"name":{"type":"string","description":"Official name of a currency"},"symbol":{"type":"string","description":"Graphic symbol of a currency"},"minorSymbol":{"type":"string","description":"Minor graphic symbol of a currency"}},"description":"Currency information"},"SecretQuestionInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the secret question"},"id":{"type":"string","description":"Internal identifier of a question"},"questionType":{"type":"integer","description":"Internal identifier of a question type"},"languageId":{"type":"string","description":"Internal identifier of a question language"},"questionText":{"type":"string","description":"Text of a secret question shown to the end user"},"showInSignUp":{"type":"boolean","description":"Specifies if the question is used during signup"}},"description":"Secret question of an extension user"},"PagingGroupExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging group user extension"},"uri":{"type":"string","description":"Link to a paging group user extension"},"extensionNumber":{"type":"string","description":"Extension number of a paging group user"},"name":{"type":"string","description":"Name of a paging group user"}}},"SiteIVRTopMenu":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR menu extension"},"uri":{"type":"string","description":"Link to an IVR menu extension resource"},"name":{"type":"string","description":"Full name of an IVR menu extension user"}},"description":"Top IVR Menu extension. Mandatory for MultiLevel mode"},"BulkTaskInfoWiCreate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points creation"},"LocationDeletionErrorInfo":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"additionalInfo":{"type":"string","description":"Additional attribute for this error, for example `parameterName`"}}},"HardPhoneLocationAutoUpdateInfo":{"type":"object","properties":{"status":{"type":"string","description":"Feature (Automatic Location Updates) activation status for hardphones","enum":["Active","Inactive","Unavailable"]}}},"ExtensionStatusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"ExtensionRegionalSettingRequest":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"ExtensionCountryInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"VoicemailsInfo":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"LicenseExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"User name of an extension"}},"description":"Information on extension to which a license can be assigned"},"ERLFeatureInfo":{"type":"object","properties":{"status":{"type":"string","description":"Feature (Emergency Response Locations) activation status","enum":["Active","Inactive","Unavailable","ActivationInProgress"]},"maxEmergencyLocations":{"type":"integer","description":"Max supported number of emergency response locations on account"},"adjustmentProcessStatus":{"type":"string","description":"Specifies if the emergency location identification numbers (ELIN) provisioning is on (active) or completed (inactive). It is not allowed to manage emergency response locations (ERL) data/settings when this process is active","enum":["Active","Inactive"]}}},"LocationUpdatesEmergencyAddressInfoRequest":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"SecretQuestionInfoValidationRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a secret question"},"answer":{"type":"string","description":"Answer to a secret question"}},"description":"Secret question of an extension user"},"AccountServiceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the account Service Info resource"},"servicePlanName":{"type":"string","description":"Account Service Plan name"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"serviceFeatures":{"type":"array","description":"Service features information, see Service Feature List","items":{"type":"object","properties":{"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"enabled":{"type":"boolean","description":"Feature status, shows feature availability for the extension"}}}},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"}},"description":"Account service information, including brand, service plan and billing plan"},"Brand":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"homeCountry":{"type":"object","properties":{"id":{"type":"string"},"uri":{"type":"string","format":"uri"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"}}}}},"OperatorInfoCreate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an operator"}},"description":"Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled"},"GetCountryInfoConferencing":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a home country of a conference phone number"},"BillingPlanInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"UpgradePackageInfo":{"type":"object","properties":{"version":{"type":"string","description":"Upgrade package version"},"id":{"type":"string","description":"Updgrade package identifier"}},"description":"Target package to be used on trial account upgrade"},"LocationInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a location"},"areaCode":{"type":"string","description":"Area code of the location"},"city":{"type":"string","description":"Official name of the city, belonging to the certain state"},"npa":{"type":"string","description":"Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"nxx":{"type":"string","description":"Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"state":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Link to a state resource"}},"description":"Information on the state this location belongs to"}}},"BrandResource":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a brand resource","format":"uri"},"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Name of a brand"},"shortName":{"type":"string","description":"Short display name of a brand"},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}},"description":"Home country setting. For extension bulk assignment the value is set automatically based on contact info setting"},"domesticCountries":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a country resource","format":"uri"},"id":{"type":"string","description":"Internal identifier of a country"},"name":{"type":"string","description":"Name of a country"},"isoCode":{"type":"string","description":"A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},"callingCode":{"type":"string","description":"Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T) recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and [E.164](http://en.wikipedia.org/wiki/E.164), see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)"}},"description":"List of brand home (domestic) countries. Typically it is one country, for Euro brand - all domestic Euro brand countries"},"currency":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a currency"},"code":{"type":"string","description":"Official code of a currency"},"name":{"type":"string","description":"Official name of a currency"},"symbol":{"type":"string","description":"Graphic symbol of a currency"},"minorSymbol":{"type":"string","description":"Minor graphic symbol of a currency"}},"description":"Currency information"},"serviceUrl":{"type":"string","description":"Link to a branded Service Web home page"},"supportLocalPhoneNumber":{"type":"string","description":"Support local phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format with a '+'"},"supportIntlPhoneNumber":{"type":"string","description":"Support international phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format with a '+'"},"additionalSupportPhoneNumber":{"type":"string","description":"Additional support phone number in [E.164](http://en.wikipedia.org/wiki/E.164) format with a '+'"},"supportUrl":{"type":"string","description":"Link to branded support page"},"callSupportUrl":{"type":"string","description":"Call support link"},"supportEmail":{"type":"string","description":"Support email address"},"signupEmail":{"type":"string","description":"Signup email address"},"notificationEmail":{"type":"string","description":"Notification email address"},"serviceEmail":{"type":"string","description":"Service email address"},"helpUrl":{"type":"string","description":"Help link"}}},"Reference":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}},"ScaledProfileImageResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"PaymentInfoCardResource":{"type":"object","properties":{"cardType":{"type":"string"},"number":{"type":"string"},"securityCode":{"type":"string"},"expiry":{"type":"string"},"token":{"type":"string"},"tokenSource":{"type":"integer"},"holder":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}}}}}}},"Address":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}}},"AddressFormCountryResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a country"},"uri":{"type":"string","description":"Country object URI"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"fieldType":{"type":"string"},"description":{"type":"string"},"maxLength":{"type":"integer","format":"int32"}}}},"emergencyNumber":{"type":"string"},"default":{"type":"boolean","default":false}}},"ExtensionUpdateShortResult":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","description":"Extension update status","enum":["Fail","Success"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}},"UserPhoneNumberInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the user's phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"features":{"type":"array","description":"List of features of a phone number","items":{"type":"string","enum":["CallerId","SmsSender","A2PSmsSender","MmsSender","InternationalSmsSender","Delegated"]}}}},"ExtensionServiceFeatureInfo":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}},"CallerIdByFeatureInfo":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}},"ExtensionAssignmentResult":{"type":"object","properties":{"successful":{"type":"boolean","default":false},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"name":{"type":"string"},"type":{"type":"string","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}},"ValidateEmergencyAddressInfoResponse":{"type":"object","properties":{"customerName":{"type":"string","description":"Customer name"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}}},"PrivateIpRangeInfo":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}},"TaskResultRecord":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the created/updated element - wireless point or network switch"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions. Returned only for 'Wireless Points Bulk Create' tasks"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. Returned only for 'Switches Bulk Create' tasks"},"status":{"type":"string","description":"Operation status"},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"parameterName":{"type":"string"},"description":{"type":"string"}}}}}},"ProvisioningNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"ERLLocationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"UserPhoneNumberExtensionInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"FormattingLocaleInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"CallerIdPhoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}},"EmailRecipientInfo":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"fullName":{"type":"string","description":"User full name"},"extensionNumber":{"type":"string","description":"User extension number"},"status":{"type":"string","description":"Current state of an extension","enum":["Enabled","Disable","NotActivated","Unassigned"]},"emailAddresses":{"type":"array","description":"List of user email addresses from extension notification settings. By default main email address from contact information is returned","items":{"type":"string"}},"permission":{"type":"string","description":"Call queue manager permission","enum":["FullAccess","MembersOnly"]}}},"PagingDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging device"},"uri":{"type":"string","description":"Link to a paging device resource"},"name":{"type":"string","description":"Name of a paging device"}}},"ErrorEntity":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}},"WirelessPointValidated":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}},"ValidationError":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}},"DomesticCountriesResource":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a country resource","format":"uri"},"id":{"type":"string","description":"Internal identifier of a country"},"name":{"type":"string","description":"Name of a country"},"isoCode":{"type":"string","description":"A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format."},"callingCode":{"type":"string","description":"Country calling code defined by [ITU-T](http://en.wikipedia.org/wiki/ITU-T) recommendations [E.123](http://en.wikipedia.org/wiki/E.123) and [E.164](http://en.wikipedia.org/wiki/E.164), see [Calling Codes](http://en.wikipedia.org/wiki/List_of_country_calling_codes)"}},"description":"List of brand home (domestic) countries. Typically it is one country, for Euro brand - all domestic Euro brand countries"},"CreateAccountOperatorInfo":{"type":"object","properties":{"type":{"type":"string","description":"Extension type"},"partnerId":{"type":"string","description":"Additional account identifier, developed and applied on client side"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"Extension user first name"},"lastName":{"type":"string","description":"Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"password":{"type":"string","description":"Extension user password"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"}},"description":"Operator's extension information. This extension will receive all calls and messages intended for the operator"},"GetServiceInfoRequest":{"type":"object","properties":{"servicePlanName":{"type":"string","description":"Account Service Plan name"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"serviceFeatures":{"type":"array","description":"Service features information, see Service Feature List","items":{"type":"object","properties":{"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"enabled":{"type":"boolean","description":"Feature status, shows feature availability for the extension"}}}},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"},"package":{"type":"object","properties":{"version":{"type":"string","description":"Billing package version"},"id":{"type":"string","description":"Billing package identifier"}}},"trial":{"type":"object","properties":{"upgradePackage":{"type":"object","properties":{"version":{"type":"string","description":"Upgrade package version"},"id":{"type":"string","description":"Updgrade package identifier"}},"description":"Target package to be used on trial account upgrade"},"durationUnit":{"type":"string","description":"Duration period","enum":["Month","Day"]},"duration":{"type":"integer","description":"Number of duration units"}}}},"description":"Account service information, brand identifier and service plan"},"AccountSignupInfoRequest":{"type":"object","properties":{"marketingAccepted":{"type":"boolean","description":"Specifies whether marketing information is sent to the user"},"tosAccepted":{"type":"boolean","description":"Specifies whether Terms of Service are accepted"}},"description":"Account sign up data"},"AccountServiceInfoResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"servicePlanName":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"homeCountry":{"type":"object","properties":{"id":{"type":"string"},"uri":{"type":"string","format":"uri"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"}}}}},"servicePlan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"edition":{"type":"string","enum":["Unknown","Standard","Premium","Enterprise","Unlimited","HighUsage"]}}},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"edition":{"type":"string","enum":["Unknown","Standard","Premium","Enterprise","Unlimited","HighUsage"]}}},"billingPlan":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"durationUnit":{"type":"string"},"duration":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","format":"int32"},"meetingSize":{"type":"integer","format":"int32"},"maxMonitoredExtensionsPerUser":{"type":"integer","format":"int32"},"maxFreeDigitalLines":{"type":"integer","format":"int32"}}}}},"TaskResultRecordErrorsInfo":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"parameterName":{"type":"string"},"description":{"type":"string"}}},"DelegateExtensionInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an extension"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Number of an extension"}}},"LookupPhoneNumberInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"formattedNumber":{"type":"string","description":"Phone number formatted according to the current brand default country"}}},"ExtensionResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"name":{"type":"string"},"type":{"type":"string","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"AutomaticLocationUpdatesPhoneNumberInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"phoneNumber":{"type":"string","description":"Phone number"}}},"CallQueuePermissionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"permission":{"type":"string","description":"Call queue manager permission. To remove call queue manager’s permission for the particular queue specify 'None'","enum":["FullAccess","MembersOnly","None"]}}},"PermissionInfoInt":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"},"ExtensionLanguageInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"AccountLimitsResource":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","format":"int32"},"meetingSize":{"type":"integer","format":"int32"},"maxMonitoredExtensionsPerUser":{"type":"integer","format":"int32"},"maxFreeDigitalLines":{"type":"integer","format":"int32"}}},"CallerIdByDevice":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by device"},"LocationStateInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Link to a state resource"}},"description":"Information on the state this location belongs to"},"ExtensionPermissionsResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"LicenseFeatureInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a feature"},"name":{"type":"string","description":"Full name of a feature"},"limit":{"type":"integer","description":"Maximum count of licenses of specific type per account"}},"description":"License feature information"},"BulkTaskInfoWiUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points update"},"ContactInfo":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"LanguageResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"ShortSiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"LocationOwnerInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}},"SharedLinesGroupPhoneLineInfo":{"type":"object","properties":{"index":{"type":"integer","description":"Sequence number of a phone line"},"label":{"type":"string","description":"Name of a phone line"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of a phone line","enum":["Standalone"]},"shared":{"type":"boolean","description":"Specifies if a phone line is already shared by this or other endpoints"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Phone line emergency settings"},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"}}}}},"SiteMemberInfo":{"type":"object","properties":{"id":{"type":"integer"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"AutomaticLocationUpdatesDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["HardPhone","SoftPhone","OtherPhone"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned)"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"name":{"type":"string","description":"Device name"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Device model identifier"},"name":{"type":"string","description":"Device name"},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"phoneNumber":{"type":"string","description":"Phone number"}}}}}}}},"AddressBookBulkContactAddressInfo":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"ContactBusinessAddressInfo":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"BulkProvisionExtensionResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"name":{"type":"string"},"type":{"type":"string","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}}},"SharedLinesGroupDeviceInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"AutomaticLocationUpdatesUserInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"fullName":{"type":"string","description":"User name"},"extensionNumber":{"type":"string"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"type":{"type":"string","description":"User extension type","enum":["User","Limited"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"department":{"type":"string","description":"Department name"}}},"PronouncedNamePromptInfo":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}},"DictionaryLicenseInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a license"},"id":{"type":"integer","description":"Internal identifier of a license"},"sku":{"type":"string","description":"Name of a license","enum":["RMS","RCN","WBR-100","WBR-500","WBR-1000","WBR-3000","WBR-5000","WBR-10000","LRM-100","LRM-200","LRM-300","LRM-500","LRP"]},"name":{"type":"string","description":"Full name of a license"},"feature":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a feature"},"name":{"type":"string","description":"Full name of a feature"},"limit":{"type":"integer","description":"Maximum count of licenses of specific type per account"}},"description":"License feature information"},"assignable":{"type":"boolean","description":"State of a license. Webinars and Large Meetings are assignable"}}},"SiteIVRTopMenuUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR menu extension"}},"description":"Top IVR Menu extension"},"GetExtensionListInfoResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}},"PermissionInfoAdmin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"ExtensionGreetingLanguageInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"GrantInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a grant"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits)"},"name":{"type":"string","description":"Name of extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation"]}},"description":"Extension information"},"callPickup":{"type":"boolean","description":"Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned"},"callMonitoring":{"type":"boolean","description":"Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned"},"callOnBehalfOf":{"type":"boolean","description":"Specifies whether the current extension is able to make or receive calls on behalf of the user referenced in extension object"},"callDelegation":{"type":"boolean","description":"Specifies whether the current extension can delegate a call to the user referenced in extension object"},"groupPaging":{"type":"boolean","description":"Specifies whether the current extension is allowed to call Paging Only group referenced to in extension object"},"callQueueSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Full-Access manager in the call queue referenced in extension object"},"callQueueMembersSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Members-Only manager in the call queue referenced in extension object"}}},"PackageInfo":{"type":"object","properties":{"version":{"type":"string","description":"Billing package version"},"id":{"type":"string","description":"Billing package identifier"}}},"ErrorsInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}},"OperatorInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an operator"},"uri":{"type":"string","description":"Link to an operator resource"},"extensionNumber":{"type":"string","description":"Extension number (pin)"},"name":{"type":"string","description":"Operator extension user full name"}},"description":"Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled"},"AddressBookBulkUploadResource":{"required":["extensionId","contacts"],"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contacts":{"type":"array","description":"List of contacts to be added to extension address book","items":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}}}}},"ExtensionFormattingLocaleInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"InboundFaxesInfo":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"ServiceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a service info resource"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"}},"description":"Account service information, including brand, service plan and billing plan"},"AccountLimits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"},"ServiceFeatureValue":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}},"DepartmentResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}},"LicenseInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a license"},"id":{"type":"string","description":"Internal identifier of a license"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a feature"},"name":{"type":"string","description":"Full name of a feature"},"limit":{"type":"integer","description":"Maximum count of licenses of specific type per account"}},"description":"License feature information"},"creationTime":{"type":"string","description":"Datetime when license was purchased in ISO 8601 format including timezone, for example 2017-03-10T18:07:52.534Z "},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"User name of an extension"}},"description":"Information on extension to which a license can be assigned"}}},"LicenseTypeInfoRequest":{"type":"object","properties":{"sku":{"type":"string","description":"Name of a license type","enum":["RMS","RCN","WBR-100","WBR-500","WBR-1000","WBR-3000","WBR-5000","WBR-10000","LRM-100","LRM-200","LRM-300","LRM-500","LRP"]}},"description":"Type of a license"},"PhoneLineNumberInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"Roles":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}},"CallQueueExtensionInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"ServicePlanInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"ContractedCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"},"ValidateEmergencyAddressInfoRequest":{"type":"object","properties":{"customerName":{"type":"string","description":"Customer name"},"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}}},"AutomaticLocationUpdatesModelInfo":{"type":"object","properties":{"id":{"type":"string","description":"Device model identifier"},"name":{"type":"string","description":"Device name"},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"FeatureInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a feature"},"available":{"type":"boolean","description":"Specifies if the feature is available for the current user according to services enabled for the account, type, entitlements and permissions of the extension. If the authorized user gets features of the other extension, only features that can be delegated are returned (such as configuration by administrators)."},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}}},"reason":{"type":"object","properties":{"code":{"type":"string","description":"Reason code","enum":["ServicePlanLimitation","AccountLimitation","ExtensionTypeLimitation","ExtensionLimitation","InsufficientPermissions","ConfigurationLimitation"]},"message":{"type":"string","description":"Reason description"},"permission":{"type":"string"}},"description":"Reason for the feature unavailability. Returned only if `available` is set to 'false'"}}},"ParamsInfo":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}},"AddressBookBulkContactResource":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}},"LocationUpdatesEmergencyAddressInfo":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"ConferencePhoneNumberInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"}}},"HomeCountryResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}},"description":"Home country setting. For extension bulk assignment the value is set automatically based on contact info setting"},"ProfileImageResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}},"BillingPlanResource":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"durationUnit":{"type":"string"},"duration":{"type":"integer","format":"int32"},"type":{"type":"string"}}},"EmergencyLocationAddressInfo":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"AccountOperatorInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an operator extension resource"},"id":{"type":"integer","description":"Internal identifier of an operator extension"},"extensionNumber":{"type":"string","description":"Number of an operator extension"}},"description":"Operator's extension information. This extension will receive all calls and messages intended for the operator."},"ReservePhoneNumberResource":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"formattedNumber":{"type":"string","description":"Domestic format of a phone number"},"reservedTill":{"type":"string","description":"Datetime up to which the number is reserved in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. No value means that number is not reserved anymore"},"reservationId":{"type":"string","description":"Internal identifier of phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"},"status":{"type":"string","description":"Phone number status = ['Enabled', 'Pending', 'Disabled'],","enum":["Enabled","Pending","Disabled"]},"error":{"type":"string","description":"The error code in case of reservation/un-reservation failure = ['NumberIsAlreadyProvisioned', 'NumberReserved', 'NumberNotAvailable']","enum":["NumberIsAlreadyProvisioned","NumberReserved","NumberNotAvailable"]}}},"QueueShortInfoResource":{"type":"object","properties":{"id":{"type":"string","description":"Call queue extension identifier"},"name":{"type":"string","description":"Call queue name (read-only)"}}},"TaskResultInfo":{"type":"object","properties":{"records":{"type":"array","description":"Detailed task results by elements from initial request","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the created/updated element - wireless point or network switch"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions. Returned only for 'Wireless Points Bulk Create' tasks"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. Returned only for 'Switches Bulk Create' tasks"},"status":{"type":"string","description":"Operation status"},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"parameterName":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Task detailed result. Returned for failed and completed tasks"},"EmergencyInfo":{"type":"object","properties":{"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Phone line emergency settings"},"CallerIdByDeviceInfo":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}},"MissedCallsInfo":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"GetCountryInfoState":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"}},"description":"Information on a country the state belongs to"},"OperatorContactInfo":{"type":"object","properties":{"firstName":{"type":"string","description":"Extension user first name"},"lastName":{"type":"string","description":"Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"password":{"type":"string","description":"Extension user password"}}},"BulkAssignItem":{"type":"object","properties":{"departmentId":{"type":"string"},"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}},"ContactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"ProfileImageInfo":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"TimezoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"SecretQuestionInfoVerificationRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a secret question"},"answer":{"type":"string","description":"Answer to a secret question"}},"description":"Secret question of an extension user"},"InboundTextsInfo":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"CompanyTransitionInfo":{"type":"object","properties":{"sendWelcomeEmail":{"type":"boolean","description":"Supported for account confirmation. Specifies whether welcome email is sent","default":true},"sendConfirmationEmail":{"type":"boolean","description":"Supported for account activation. Specifies whether confirmation email is sent","default":true},"shipDevices":{"type":"boolean","description":"Specifies whether devices are shipped after successful account confirmation","default":true},"activationEmailHash":{"type":"string","description":"Supported for account confirmation. Activation email hash code"}},"description":"Email notifications setting"},"InvoiceSettingsResource":{"type":"object","properties":{"maxAmountPerFirstMonth":{"type":"integer","format":"int64"},"maxAmountPerMonth":{"type":"integer","format":"int64"},"paymentTerm":{"type":"integer","format":"int64"},"period":{"type":"integer","format":"int64"},"address":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}}}}},"GetExtensionAccountInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"}},"description":"Account information"},"SiteInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Extension user first name"},"extensionNumber":{"type":"string","description":"Extension number"},"callerIdName":{"type":"string","description":"Custom name of a caller. Max number of characters is 15 (only alphabetical symbols, numbers and commas are supported)"},"email":{"type":"string","description":"Exetnsion user email"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"operator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an operator"},"uri":{"type":"string","description":"Link to an operator resource"},"extensionNumber":{"type":"string","description":"Extension number (pin)"},"name":{"type":"string","description":"Operator extension user full name"}},"description":"Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled"},"code":{"type":"string","description":"Site code value. Returned only if specified"}}},"LicenseInfoRequest":{"type":"object","properties":{"type":{"type":"object","properties":{"sku":{"type":"string","description":"Name of a license type","enum":["RMS","RCN","WBR-100","WBR-500","WBR-1000","WBR-3000","WBR-5000","WBR-10000","LRM-100","LRM-200","LRM-300","LRM-500","LRP"]}},"description":"Type of a license"},"quantity":{"type":"integer","description":"Quantity of licenses to be purchased"}}},"PhoneLineInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"}}},"CallMonitoringExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}},"AutomaticLocationUpdatesPhoneLine":{"type":"object","properties":{"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"phoneNumber":{"type":"string","description":"Phone number"}}}}},"ExtensionBulkUpdateInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","enum":["Disabled","Enabled","NotActivated","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"reason":{"type":"string","description":"Type of suspension"},"comment":{"type":"string","description":"Free form user comment"},"extensionNumber":{"type":"string","description":"Extension number available"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed"]},"partnerId":{"type":"string","description":"Additional extension identifier created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"password":{"type":"string","description":"Password for extension"},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"transition":{"type":"object","items":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","DelegatedLinesGroup"]},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}}}},"ContactInfoCreationRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact Information"},"ContactInfoUpdateRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"FormFieldResource":{"type":"object","properties":{"name":{"type":"string"},"fieldType":{"type":"string"},"description":{"type":"string"},"maxLength":{"type":"integer","format":"int32"}}},"CallQueueServiceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"LocationDeletionInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"deletion":{"type":"string","description":"Identifies the possibility and status of emergency location deletion","enum":["Failed","Completed","Forbidden","Restricted","Allowed"]},"errors":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"additionalInfo":{"type":"string","description":"Additional attribute for this error, for example `parameterName`"}}}}},"CallMonitoringGroupMemberInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group member"},"id":{"type":"string","description":"Internal identifier of a call monitoring group member"},"extensionNumber":{"type":"string","description":"Extension number of a call monitoring group member"},"permissions":{"type":"array","items":{"type":"string","description":"Call monitoring permission; mltiple values are allowed: * `Monitoring` - User can monitor a group * `Monitored` - User can be monitored\n","enum":["Monitoring","Monitored"]}}}},"SiteIVRActionsExtensionInfoUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension information"},"ExtensionPermissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"BusinessAddressInfo":{"type":"object","properties":{"country":{"type":"string","description":"Name of a country"},"state":{"type":"string","description":"Name of a state/province"},"city":{"type":"string","description":"Name of a city"},"street":{"type":"string","description":"Street address"},"zip":{"type":"string","description":"Zip code"}},"description":"Company business address"},"PaymentInfoCardHolderResource":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}}}}},"SiteIvrActionsUpdate":{"type":"object","properties":{"input":{"type":"string","enum":["Start","Hash","NoInput","0"]},"action":{"type":"string","description":"Key handling action: * Repeat - repeat menu greeting, for Star and Hash only * ReturnToRoot - return to root IVR menu, for Star and Hash only; * ReturnToPrevious - return to previous IVR menu, for Star and Hash only; * Connect - connect to specific extension, for NoInput and \"0\" (zero) only; * Disconnect - end call, for NoInput only.\n","enum":["Repeat","ReturnToRoot","ReturnToPrevious","ReturnToTopLevelMenu","Connect","ConnectToOperator","Disconnect","DoNothing"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension information"}},"description":"Keys handling settings"},"ProvisioningPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"ProvisioningNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"UserTransitionInfo":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"},"PaymentInfoAddressResource":{"type":"object","properties":{"country":{"type":"string"},"state":{"type":"string"},"city":{"type":"string"},"street":{"type":"string"},"zip":{"type":"string"}}},"SiteIvrActions":{"type":"object","properties":{"input":{"type":"string","enum":["Star","Hash","NoInput"]},"action":{"type":"string","description":"Key handling action: * Repeat - repeat menu greeting, for Star and Hash only * ReturnToRoot - return to root IVR menu, for Star and Hash only; * ReturnToPrevious - return to previous IVR menu, for Star and Hash only; * Connect - connect to specific extension, for NoInput only; * Disconnect - end call, for NoInput only.\n","enum":["Repeat","ReturnToRoot","ReturnToPrevious","ReturnToTopLevelMenu","Connect","Disconnect","DoNothing"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"name":{"type":"string","description":"Name of an extension user"}},"description":"Extension information"}},"description":"Keys handling settings"},"ServiceFeatureInfo":{"type":"object","properties":{"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"enabled":{"type":"boolean","description":"Feature status, shows feature availability for the extension"}}},"ExtensionReferenceResource":{"type":"object","properties":{"id":{"type":"string"},"partnerId":{"type":"string"}}},"StatusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"HomeCountry":{"type":"object","properties":{"id":{"type":"string"},"uri":{"type":"string","format":"uri"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"}}},"WirelessPointInfoRequest":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}},"SwitchValidated":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}},"GreetingLanguageInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"CallerIdByFeature":{"type":"object","properties":{"feature":{"type":"string","enum":["RingOut","RingMe","CallFlip","FaxNumber","AdditionalSoftphone","Alternate","CommonPhone","MobileApp","Delegated"]},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by feature"},"ExtensionSecretQuestionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a secret question"},"uri":{"type":"string","description":"Link to a secret question resource"},"answer":{"type":"string","description":"Answer to a secret question"}}},"ExtensionInfoGrants":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits)"},"name":{"type":"string","description":"Name of extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation"]}},"description":"Extension information"},"RegionalSettingsResource":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"FormsAddressCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a country"},"uri":{"type":"string","description":"Country object URI"}}},"BulkTaskInfoSwUpdate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple switches update"},"CountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"ProfileImageInfoURI":{"type":"object","properties":{"uri":{"type":"string"}}},"PhoneLineInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of a phone line","enum":["Standalone"]},"shared":{"type":"boolean","description":"Specifies if a phone line is already shared by this or other endpoints"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Phone line emergency settings"},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"}}},"CallQueueMemberInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queue member"},"id":{"type":"integer","description":"Internal identifier of a call queue member"},"extensionNumber":{"type":"string","description":"Extension number of a call queue member"}}},"ExtensionListEventBody":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Create","Update","Delete"]},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"},"ParsePhoneNumberRequest":{"type":"object","properties":{"originalStrings":{"type":"array","description":"Phone numbers passed in a string. The maximum value of phone numbers is limited to 64. The maximum number of symbols in each phone number in a string is 64","items":{"type":"string"}}}},"ParsePhoneNumberResponse":{"required":["homeCountry","phoneNumbers"],"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a resource"},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"phoneNumbers":{"type":"array","description":"Parsed phone numbers data","items":{"type":"object","properties":{"areaCode":{"type":"string","description":"Area code of location. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a specific geographic region/numbering area of the national numbering plan (NANP); that can be summarized as `NPA-NXX-xxxx` and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See [North American Numbering Plan] (https://en.wikipedia.org/wiki/North_American_Numbering_Plan) for details"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"dialable":{"type":"string","description":"Dialing format of a phone number"},"e164":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"formattedInternational":{"type":"string","description":"International format of a phone number"},"formattedNational":{"type":"string","description":"Domestic format of a phone number"},"originalString":{"type":"string","description":"One of the numbers to be parsed, passed as a string in response"},"special":{"type":"boolean","description":"'True' if the number is in a special format (for example N11 code)"},"normalized":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format without plus sign ('+')"},"tollFree":{"type":"boolean","description":"Specifies if a phone number is toll free or not"},"subAddress":{"type":"string","description":"Sub-Address. The portion of the number that identifies a subscriber into the subscriber internal (non-public) network."},"subscriberNumber":{"type":"string","description":" Subscriber number. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a subscriber in a network or numbering area."},"dtmfPostfix":{"type":"string","description":"DTMF (Dual Tone Multi-Frequency) postfix"}}}}}},"GetCountryInfoNumberParser":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"PhoneNumberInfoNumberParser":{"type":"object","properties":{"areaCode":{"type":"string","description":"Area code of location. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a specific geographic region/numbering area of the national numbering plan (NANP); that can be summarized as `NPA-NXX-xxxx` and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See [North American Numbering Plan] (https://en.wikipedia.org/wiki/North_American_Numbering_Plan) for details"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"dialable":{"type":"string","description":"Dialing format of a phone number"},"e164":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"formattedInternational":{"type":"string","description":"International format of a phone number"},"formattedNational":{"type":"string","description":"Domestic format of a phone number"},"originalString":{"type":"string","description":"One of the numbers to be parsed, passed as a string in response"},"special":{"type":"boolean","description":"'True' if the number is in a special format (for example N11 code)"},"normalized":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format without plus sign ('+')"},"tollFree":{"type":"boolean","description":"Specifies if a phone number is toll free or not"},"subAddress":{"type":"string","description":"Sub-Address. The portion of the number that identifies a subscriber into the subscriber internal (non-public) network."},"subscriberNumber":{"type":"string","description":" Subscriber number. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a subscriber in a network or numbering area."},"dtmfPostfix":{"type":"string","description":"DTMF (Dual Tone Multi-Frequency) postfix"}}},"GetDeviceInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["BLA","SoftPhone","OtherPhone","HardPhone","WebPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name"},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"billingStatement":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code complying with [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard"},"charges":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"feature":{"type":"string"},"freeServiceCredit":{"type":"number"}}}},"fees":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"freeServiceCredit":{"type":"number"}}}},"totalCharged":{"type":"number"},"totalCharges":{"type":"number"},"totalFees":{"type":"number"},"subtotal":{"type":"number"},"totalFreeServiceCredit":{"type":"number"}},"description":"Billing information. Returned for device update request if `prestatement` query parameter is set to 'true'"}}},"AccountDeviceUpdate":{"type":"object","properties":{"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"}},"description":"Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in `emergency` resource, then this value is ignored"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on extension that the device is assigned to"},"phoneLines":{"type":"object","properties":{"phoneLines":{"type":"array","description":"Information on phone lines added to a device","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"}}}}},"description":"Information on phone lines added to a device"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."}}},"GetExtensionDevicesResponse":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of extension devices"},"records":{"type":"array","description":"List of extension devices","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["SoftPhone","OtherPhone","HardPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}},"EmergencyServiceAddressResource":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"DeviceUpdatePhoneLinesInfo":{"type":"object","properties":{"phoneLines":{"type":"array","description":"Information on phone lines added to a device","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"}}}}},"description":"Information on phone lines added to a device"},"DeviceProvisioningPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"EmergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"ShippingMethod":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a shipping method"},"name":{"type":"string","description":"Name/description of a shipping method"}},"description":"Shipping method description"},"UpdateDevicePhoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"}}},"DeviceEmergencyInfoRequest":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"}},"description":"Device emergency settings"},"PhoneNumberCountryInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"ExtensionDeviceResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["SoftPhone","OtherPhone","HardPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"TaskInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"uri":{"type":"string","description":"Link to a task resource"},"status":{"type":"string","description":"Device order status","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Time of task last modification","format":"date-time"}},"description":"For Async Order Only. Information on device ordering task"},"ExtensionContactInfo":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"ShippingInfo":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"DeviceProvisioningExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"ContactAddressInfoDevices":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"},"MethodInfo":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"ShippingAddressInfo":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"},"ShippingResource":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer"},"DeviceOrderExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the device will be assigned to. The following extension types are accepted for device assignment: User, DigitalUser, VirtualUser, FaxUser, SharedLinesGroup, Limited (ParkLocation)"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"BillingStatementFees":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"freeServiceCredit":{"type":"number"}}},"DeviceProvisioningNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"DeviceEmergencyInfo":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"PhoneLinesInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}},"DeviceResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["BLA","HardPhone","SoftPhone","OtherPhone","Paging","WebPhone"]},"status":{"type":"string","description":"Status of a device","enum":["Online","Offline"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name"},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"This attribute can be omitted for unassigned devices"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"reservationId":{"type":"string","description":"Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"}}},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified for HardPhone"},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if device is located in the configured corporate network, in this case `bssid` or public/private IP addresses (`hostIp`) must be found in the corporate maps. If `bssid` is not found in the Wireless Access Points map, then the search is performed by public/private IP addresses in the IP Networks map. 'False' if network parameters are not found in corporate maps (`bssid` and public/private IP addresses for wi-fi or for Ethernet connection)"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"GetAccountDeviceInfoResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["SoftPhone","OtherPhone","HardPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name"},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"DeviceProvisioningNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"BillingStatementCharges":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"feature":{"type":"string"},"freeServiceCredit":{"type":"number"}}},"DeviceUpdateExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on extension that the device is assigned to"},"AddonInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}},"ExtensionResourceIntId":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"integer","format":"int64"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"This attribute can be omitted for unassigned devices"},"PhoneNumberResourceIntId":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"reservationId":{"type":"string","description":"Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"}}},"RegionalSettingsInfo":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"DeviceEmergencyLocationInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"DeviceEmergencyAddressInfo":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned for 'Get Device Info' request if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]}},"description":"Automatically determined emergency address. If `emergencyAddressState` value is 'Assigned', then this address is assigned to the current device. If `emergencyAddressState` value is 'Unconfirmed', then the specified address must be confirmed by the user before being registered as emergency address for the current device. In all other cases the value is null"},"PhoneLineResource":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"reservationId":{"type":"string","description":"Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"}}},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}},"PhoneNumberExtensionInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"DeviceModelExtResource":{"type":"object","properties":{"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["SoftPhone","HardPhone","OtherPhone"]},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"}}},"DeviceInfo":{"type":"object","properties":{"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["HardPhone","SoftPhone","OtherPhone","Paging","WebPhone"]},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the device will be assigned to. The following extension types are accepted for device assignment: User, DigitalUser, VirtualUser, FaxUser, SharedLinesGroup, Limited (ParkLocation)"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"extension":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"partnerId":{"maxLength":128,"minLength":0,"pattern":"^[\\p{Alnum}\\.\\-_]*$","type":"string"},"extensionNumber":{"type":"string"},"loginName":{"type":"string"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}},"description":"Business address of extension user company"}}},"references":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["PartnerId","CustomerDirectoryId"]},"ref":{"type":"string"}}}},"name":{"type":"string"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["Unknown","User","Department","Announcement","Voicemail","DigitalUser","VirtualUser","FaxUser","PagingOnly","SharedLinesGroup","IvrMenu","ApplicationExtension","ParkLocation"]},"status":{"type":"string","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"reason":{"type":"string"},"till":{"type":"string","format":"date-time"},"comment":{"type":"string"}}},"departments":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"extensionNumber":{"type":"string"}}}},"serviceFeatures":{"type":"array","items":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean","default":false},"reason":{"type":"string","enum":["Available","AccountTypeLimitation","ExtensionTypeLimitation","AccountLimitation","ExtensionLimitation","InsufficientPermissions","ApplicationLimitation"]}}}},"regionalSettings":{"type":"object","properties":{"timezone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"homeCountry":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}},"language":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"localeCode":{"type":"string"}}}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed","Unknown"]},"permissions":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"admin":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}},"freeSoftPhoneDigitalLine":{"type":"object","properties":{"enabled":{"type":"boolean","default":false}}}}},"password":{"type":"string"},"ivrPin":{"type":"string"},"profileImage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"etag":{"type":"string"},"contentType":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"scales":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}},"description":"Information on an extension to which the phone number is assigned"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"reservationId":{"type":"string","description":"Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time"}}},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer"},"name":{"type":"string","description":"Device name"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"}}},"CreateDeviceExtensionInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"This attribute can be omitted for unassigned devices"},"ExtensionInfoIntId":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"PhoneNumberInfoIntId":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"EmergencyServiceAddressResourceRequest":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"}},"description":"Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in `emergency` resource, then this value is ignored"},"ModelInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"BillingStatementInfo":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code complying with [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard"},"charges":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"feature":{"type":"string"},"freeServiceCredit":{"type":"number"}}}},"fees":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"freeServiceCredit":{"type":"number"}}}},"totalCharged":{"type":"number"},"totalCharges":{"type":"number"},"totalFees":{"type":"number"},"subtotal":{"type":"number"},"totalFreeServiceCredit":{"type":"number"}},"description":"Billing information. Returned for device update request if `prestatement` query parameter is set to 'true'"},"DeviceEmergencyAddress":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"User":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}},"UserPatch":{"required":["Operations","schemas"],"type":"object","properties":{"Operations":{"type":"array","description":"patch operations list","items":{"required":["op"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"string"},"value":{"type":"string","description":"corresponding 'value' of that field specified by 'path'"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}}},"ServiceProviderConfig":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}}},"bulk":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"etag":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"filter":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"patch":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"xmlDataFormat":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}}}},"UserSearchResponse":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}},"ScimErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}},"CreateUser":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"User status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}},"UserResponse":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}},"SearchRequest":{"type":"object","properties":{"count":{"type":"integer","description":"page size","format":"int32"},"filter":{"type":"string","description":"only support 'userName' or 'email' filter expressions for now"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]}},"startIndex":{"type":"integer","description":"start index (1-based)","format":"int32"}}},"AuthenticationScheme":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}},"BulkSupported":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"Supported":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"FilterSupported":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"PhoneNumber":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}},"EnterpriseUser":{"type":"object","properties":{"department":{"type":"string"}}},"UserAddress":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}},"Email":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}},"Name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"Photo":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}},"PatchOperation":{"required":["op"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"string"},"value":{"type":"string","description":"corresponding 'value' of that field specified by 'path'"}}},"Meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"},"MakeCallOutRequest":{"required":["from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"deviceId":{"type":"string","description":"Internal identifier of a device","example":"59474004"}},"description":"Instance id of the caller. It corresponds to the 1st leg of the CallOut call."},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format","example":16502223366},"extensionNumber":{"type":"string","description":"Extension number","example":"103"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call"}}},"TransferTarget":{"type":"object","description":"Identifier of a call party the call will be transfered to. Only **one of** these parameters: `phoneNumber`, `voicemail`, `extensionNumber` or `parkOrbit` must be specified, otherwise an error is returned.","properties":{"phoneNumber":{"type":"string","description":"Phone number"},"voicemail":{"type":"string","description":"Voicemail owner extension identifier"},"parkOrbit":{"type":"string","description":"Park orbit identifier"},"extensionNumber":{"type":"string","description":"Number of extension"}}},"BridgeTargetRequest":{"required":["partyId","telephonySessionId"],"type":"object","properties":{"telephonySessionId":{"type":"string","description":"Internal identifier of a call session to be connected to (bridged)"},"partyId":{"type":"string","description":"Internal identifier of a call party to be connected to (bridged)"}}},"CallPartyReply":{"type":"object","properties":{"replyWithText":{"type":"string","description":"Text to reply"},"replyWithPattern":{"type":"object","properties":{"pattern":{"type":"string","description":"Predefined reply pattern name.","example":"OnMyWay","enum":["WillCallYouBack","CallMeBack","OnMyWay","OnTheOtherLine","WillCallYouBackLater","CallMeBackLater","InAMeeting","OnTheOtherLineNoCall"]},"time":{"type":"integer","description":"Number of time units. Applicable only to WillCallYouBack, CallMeBack patterns.","example":5},"timeUnit":{"type":"string","description":"Time unit name.","example":"Minute","enum":["Minute","Hour","Day"]}}}}},"CallSessionObject":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call session"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"voiceCallToken":{"type":"string","description":"For calls of 'Conference' type only"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}},"creationTime":{"type":"string","description":"Date and time of the latest session update represented in Unix time format"}},"description":"Call session information"},"CallPartyFlip":{"type":"object","properties":{"callFlipId":{"type":"string","description":"Call flip id"}}},"PartySuperviseResponse":{"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"direction":{"type":"string","description":"Direction of a call","enum":["Outbound","Inbound"]},"id":{"type":"string","description":"Internal identifier of a party that monitors a call"},"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"},"muted":{"type":"boolean","description":"Specifies if a call party is muted"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"standAlone":{"type":"boolean","description":"Specifies if a device is stand-alone"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"}}},"CallSession":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call session"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"voiceCallToken":{"type":"string","description":"For calls of 'Conference' type only"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}},"creationTime":{"type":"string","description":"Date and time of the latest session update represented in Unix time format"}},"description":"Call session information"}}},"CallParty":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"},"IgnoreRequestBody":{"required":["deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Internal device identifier","example":"400020454008"}}},"AnswerTarget":{"type":"object","properties":{"deviceId":{"type":"string","description":"Device identifier that is used to answer the incoming call.","example":"400018633008"}}},"ForwardTarget":{"type":"object","description":"Identifier of a call party the call will be forwarded to. Only **one of** these parameters: `phoneNumber`, `voicemail` or `extensionNumber` must be specified, otherwise an error is returned.","properties":{"phoneNumber":{"type":"string","description":"Phone number"},"voicemail":{"type":"string","description":"Voicemail owner extension identifier"},"extensionNumber":{"type":"string","description":"Number of an extension"}}},"ReplyParty":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]}}},"AddPartyRequest":{"required":["partyId","telephonySessionId"],"type":"object","properties":{"telephonySessionId":{"type":"string","description":"Internal identifier of a call session"},"partyId":{"type":"string","description":"Internal identifier of a party that should be added to the call session"}}},"CallRecording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call recording"},"active":{"type":"boolean","description":"Call recording status"}}},"SuperviseCallSession":{"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that monitors a call"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that is monitored"},"direction":{"type":"string","description":"Direction of a call","enum":["Outbound","Inbound"]},"id":{"type":"string","description":"Internal identifier of a party that monitors a call"},"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"}}},"PickupTarget":{"required":["deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Device identifier that is used to pick up the parked call.","example":"400018633008"}}},"PartyUpdateRequest":{"type":"object","properties":{"party":{"type":"object","properties":{"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"}},"description":"Party update data"}}},"CallRecordingUpdate":{"type":"object","properties":{"active":{"type":"boolean","description":"Recording status"}}},"SuperviseCallSessionRequest":{"required":["mode","supervisorDeviceId"],"type":"object","properties":{"mode":{"type":"string","description":"Supervising mode","example":"Listen","enum":["Listen"]},"supervisorDeviceId":{"type":"string","description":"Internal identifier of a supervisor's device which will be used for call session monitoring","example":"191888004"},"agentExtensionNumber":{"type":"string","description":"Extension number of the user that will be monitored","example":"105"},"agentExtensionId":{"type":"string","description":"Extension identifier of the user that will be monitored","example":"400378008008"}}},"PartySuperviseRequest":{"required":["agentExtensionId","mode","supervisorDeviceId"],"type":"object","properties":{"mode":{"type":"string","description":"Supervising mode","example":"Listen","enum":["Listen"]},"supervisorDeviceId":{"type":"string","description":"Internal identifier of a supervisor's device","example":"191888004"},"agentExtensionId":{"type":"string","description":"Mailbox ID of a user that will be monitored","example":"400378008008"}}},"OwnerInfo":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"PartyUpdateInfo":{"type":"object","properties":{"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"}},"description":"Party update data"},"MakeCallOutCallerInfoRequestFrom":{"type":"object","properties":{"deviceId":{"type":"string","description":"Internal identifier of a device","example":"59474004"}},"description":"Instance id of the caller. It corresponds to the 1st leg of the CallOut call."},"MakeCallOutCallerInfoRequestTo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format","example":16502223366},"extensionNumber":{"type":"string","description":"Extension number","example":"103"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call"},"PatternInfo":{"type":"object","properties":{"pattern":{"type":"string","description":"Predefined pattern identifier","enum":["WillCallYouBack","CallMeBack","OnMyWay","OnTheOtherLine","WillCallYouBackLater","CallMeBackLater","InAMeeting","OnTheOtherLineNoCall"]},"time":{"type":"integer","description":"Number of time units. Supported only for 'WillCallYouBack', 'CallMeBack' patterns"},"timeUnit":{"type":"string","description":"Time unit","enum":["Minute","Hour","Day"]}},"description":"Predefined text pattern that will be sent as reply to an incoming call"},"TelephonySessionsEventBody":{"type":"object","properties":{"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"sessionId":{"type":"string","description":"Legacy identifier of a call session"},"telephonySessionId":{"type":"string","description":"Call session identifier, required for Telephony API"},"serverId":{"type":"string","description":"Identifier of a server"},"eventTime":{"type":"string","description":"The call start datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"parties":{"type":"array","description":"Call participants details","items":{"type":"object","properties":{"accountId":{"type":"string"},"extensionId":{"type":"string"},"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Call party phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format"},"name":{"type":"string","description":"Call party name"},"extensionId":{"type":"string","description":"Internal identifier of a call party extensionId"}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Call party phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format"},"name":{"type":"string","description":"Call party name"},"extensionId":{"type":"string","description":"Internal identifier of a call party extensionId"}}},"status":{"type":"object","properties":{"code":{"type":"string"},"reason":{"type":"string"},"parkData":{"type":"string"},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"mobilePickupData":{"type":"object","properties":{"ccMailboxes":{"type":"array","description":"List of extension IDs, configured to pick up a call from Desktop/Mobile applications","items":{"type":"string"}},"to":{"type":"string","description":"SIP proxy registration name"},"sid":{"type":"string","description":"User data"},"srvlvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}}}}}}}}},"description":"Notification payload body"},"CallStatusInfo":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"ParkInfo":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"PeerInfo":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"SupervisePartyFrom":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that monitors a call"},"PartyInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"OriginInfo":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"ResyncResponseDataItem":{"type":"object","properties":{"instanceId":{"type":"integer","description":"Device instance ID","example":59474004}}},"SupervisePartyTo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that is monitored"},"TelephonySessionsEventPartyInfo":{"type":"object","properties":{"accountId":{"type":"string"},"extensionId":{"type":"string"},"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Call party phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format"},"name":{"type":"string","description":"Call party name"},"extensionId":{"type":"string","description":"Internal identifier of a call party extensionId"}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Call party phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format"},"name":{"type":"string","description":"Call party name"},"extensionId":{"type":"string","description":"Internal identifier of a call party extensionId"}}},"status":{"type":"object","properties":{"code":{"type":"string"},"reason":{"type":"string"},"parkData":{"type":"string"},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"mobilePickupData":{"type":"object","properties":{"ccMailboxes":{"type":"array","description":"List of extension IDs, configured to pick up a call from Desktop/Mobile applications","items":{"type":"string"}},"to":{"type":"string","description":"SIP proxy registration name"},"sid":{"type":"string","description":"User data"},"srvlvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}}}}}}},"MobilePickupData":{"type":"object","properties":{"ccMailboxes":{"type":"array","description":"List of extension IDs, configured to pick up a call from Desktop/Mobile applications","items":{"type":"string"}},"to":{"type":"string","description":"SIP proxy registration name"},"sid":{"type":"string","description":"User data"},"srvlvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}}},"RecordingInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}},"PlayResource":{"type":"object","properties":{"uri":{"type":"string","description":"Absolute path to media resource.","example":"http://somepath/filename.wav"},"custom":{"type":"string","description":"Absolute path to custom greeting.","example":"http://10.62.27.67:80/MSS/?cmd=download&file=dir1_1/20190607/1745/mes01-t01-mss01/299F0.wav"},"system":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"System message.","example":"Thank you for holding. Reply from is: I will call you back in minutes."},"values":{"type":"array","description":"Wildcard values for system message.","items":{"type":"string"}}}}}},"ReplyWithPattern":{"type":"object","properties":{"pattern":{"type":"string","description":"Predefined reply pattern name.","example":"OnMyWay","enum":["WillCallYouBack","CallMeBack","OnMyWay","OnTheOtherLine","WillCallYouBackLater","CallMeBackLater","InAMeeting","OnTheOtherLineNoCall"]},"time":{"type":"integer","description":"Number of time units. Applicable only to WillCallYouBack, CallMeBack patterns.","example":5},"timeUnit":{"type":"string","description":"Time unit name.","example":"Minute","enum":["Minute","Hour","Day"]}}},"RCCInfo":{"type":"object","properties":{"conferencePhoneNumber":{"type":"string","description":"Conferencing phone number"},"conferencePins":{"type":"array","items":{"type":"string"}}}},"CallPartyInfo":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Call party phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format"},"name":{"type":"string","description":"Call party name"},"extensionId":{"type":"string","description":"Internal identifier of a call party extensionId"}}},"CallSessionStatusInfo":{"type":"object","properties":{"code":{"type":"string"},"reason":{"type":"string"},"parkData":{"type":"string"},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"mobilePickupData":{"type":"object","properties":{"ccMailboxes":{"type":"array","description":"List of extension IDs, configured to pick up a call from Desktop/Mobile applications","items":{"type":"string"}},"to":{"type":"string","description":"SIP proxy registration name"},"sid":{"type":"string","description":"User data"},"srvlvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"}}}}},"DataExportTask":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a task"},"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task last modification datetime"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed","Expired"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"specific":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"datasets":{"type":"array","description":"Data collection sets. Returned by task ID","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}}}}},"DataExportTaskList":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a task"},"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task last modification datetime"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed","Expired"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"specific":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"datasets":{"type":"array","description":"Data collection sets. Returned by task ID","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}}}},"CreateDataExportTaskRequest":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection. The default value is `timeTo` minus 24 hours. Max allowed time frame between `timeFrom` and `timeTo` is 6 months"},"timeTo":{"type":"string","description":"Ending time for data collection. The default value is current time. Max allowed time frame between `timeFrom` and `timeTo` is 6 months"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected. Maximum number of chats supported is 10","items":{"type":"string"}}}},"GlipDataExportPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}},"SpecificInfo":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"ExportTaskResultInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}},"GlipDataExportNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"DataExportTaskContactInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."},"GlipDataExportNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}},"MessageStoreReport":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message store report task"},"uri":{"type":"string","description":"Link to a task"},"status":{"type":"string","description":"Status of a message store report task","enum":["Accepted","Pending","InProgress","AttemptFailed","Failed","Completed","Cancelled"]},"accountId":{"type":"string","description":"Internal identifier of an account"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the last task modification"},"dateTo":{"type":"string","description":"Ending time for collecting messages"},"dateFrom":{"type":"string","description":"Starting time for collecting messages"}}},"CreateMessageStoreReportRequest":{"type":"object","properties":{"dateFrom":{"type":"string","description":"Starting time for collecting messages. The default value equals to the current time minus 24 hours"},"dateTo":{"type":"string","description":"Ending time for collecting messages. The default value is the current time"}}},"MessageStoreReportArchive":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"size":{"type":"integer","description":"Archive size in bytes"},"uri":{"type":"string","description":"Link for archive download"}}}}}},"ArchiveInfo":{"type":"object","properties":{"size":{"type":"integer","description":"Archive size in bytes"},"uri":{"type":"string","description":"Link for archive download"}}},"ListMeetingRecordingsResponse":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"meeting":{"type":"object","properties":{"id":{"type":"string"},"topic":{"type":"string"},"startTime":{"type":"string"}}},"recording":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentDownloadUri":{"type":"string","description":"Link for downloading the recorded file (mp4, mp3 audio and text/plain chat file)"},"contentType":{"type":"string","enum":["video/mp4","audio/m4a","text/plain"]},"size":{"type":"integer","format":"int32"},"startTime":{"type":"string","description":"Starting time of a recording"},"endTime":{"type":"string","description":"Ending time of a recording"},"status":{"type":"string","enum":["Completed","Processing"]}}}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}}}},"MeetingRecordingsPagingInfo":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}},"MeetingRecordingsNavigationInfo":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}},"MeetingInfo":{"type":"object","properties":{"id":{"type":"string"},"topic":{"type":"string"},"startTime":{"type":"string"}}},"MeetingRecordingInfo":{"type":"object","properties":{"id":{"type":"string"},"contentDownloadUri":{"type":"string","description":"Link for downloading the recorded file (mp4, mp3 audio and text/plain chat file)"},"contentType":{"type":"string","enum":["video/mp4","audio/m4a","text/plain"]},"size":{"type":"integer","format":"int32"},"startTime":{"type":"string","description":"Starting time of a recording"},"endTime":{"type":"string","description":"Ending time of a recording"},"status":{"type":"string","enum":["Completed","Processing"]}}},"MeetingRecordingsNavigationInfoUri":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"MeetingRecording":{"type":"object","properties":{"meeting":{"type":"object","properties":{"id":{"type":"string"},"topic":{"type":"string"},"startTime":{"type":"string"}}},"recording":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentDownloadUri":{"type":"string","description":"Link for downloading the recorded file (mp4, mp3 audio and text/plain chat file)"},"contentType":{"type":"string","enum":["video/mp4","audio/m4a","text/plain"]},"size":{"type":"integer","format":"int32"},"startTime":{"type":"string","description":"Starting time of a recording"},"endTime":{"type":"string","description":"Ending time of a recording"},"status":{"type":"string","enum":["Completed","Processing"]}}}}}},"CustomFieldUpdateRequest":{"type":"object","properties":{"displayName":{"type":"string","description":"Custom field display name"}}},"CustomFieldCreateRequest":{"type":"object","properties":{"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}},"CustomFieldResource":{"type":"object","properties":{"id":{"type":"string","description":"Custom field identifier"},"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}},"CustomFieldsResource":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom field identifier"},"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}}}}},"CreateSMSMessageBatchRequest":{"required":["from","messages"],"type":"object","properties":{"from":{"type":"string","description":"Sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format.","example":15551234567},"text":{"type":"string","description":"Text to send to `messages.to` phone numbers. Can be overridden on a per-message basis","example":"Hello, World!"},"messages":{"type":"array","description":"Individual messages","items":{"required":["to"],"type":"object","properties":{"to":{"type":"array","description":"List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, recipients of this message. Currently only one number is supported","example":15551234567,"items":{"type":"string"}},"text":{"type":"string","description":"Text to send, maximum number of characters is 1000","example":"Hello, World!"}},"description":"Single individual SMS resource"}}},"description":"Batch of A2P SMS messages. This object provides specification to send message(s) to many recipients. It contains top-level attributes, such as `text` which apply to all `messages`. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients."},"MessageBatchResponse":{"required":["from","messages"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the message batch","readOnly":true,"example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent","example":15551234567},"batchSize":{"type":"integer","description":"Total number of messages in the accepted batch","example":5},"processedCount":{"type":"integer","description":"Total number of messages currently processed in the batch","example":1},"lastModifiedTime":{"type":"string","description":"The last time the batch was processed.\n","format":"date-time"},"status":{"type":"string","description":"Current status of a message batch","example":"Processing","enum":["Processing","Sent","Completed"]},"creationTime":{"type":"string","description":"The time at which the batch was created\n","format":"date-time"}},"description":"Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients"},"MessageDetailsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message","example":"1234"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message was sent","example":15551234567},"to":{"type":"array","description":"List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which the message was sent","example":15551234567,"items":{"type":"string"}},"text":{"type":"string","description":"Text of a message, maximum number of characters is 1000","example":"Hello, World!"},"creationTime":{"type":"string","format":"date-time","description":"The time when this is message was created."},"lastModifiedTime":{"type":"string","format":"date-time","description":"The time when this message was last updated."},"messageStatus":{"type":"string","description":"Current status of a message","example":"Queued","enum":["Queued","Delivered","Sent","SendingFailed","DeliveryFailed"]},"segmentCount":{"type":"integer","description":"Number of segments of a message","format":"int64","example":1},"cost":{"type":"number","description":"Cost of a message","format":"double","example":0.007},"batchId":{"type":"string","description":"The batch in which the message was submitted","example":"batch12345"},"direction":{"type":"string","enum":["Inbound","Outbound"],"description":"Indicates whether the message is outbound or inbound","example":"out"},"errorCode":{"type":"string","description":"RC error code of the message sending failure reason","example":"SMS-RC-503"}},"description":"Detailed information on a message"},"MessageListResponse":{"type":"object","properties":{"records":{"type":"array","description":"An array containing individual messages","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message","format":"int64","example":1234},"batchId":{"type":"string","description":"Internal identifier of a batch the message was submitted in","example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message is sent","example":15551234567},"to":{"type":"array","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which a message is sent","example":15551234567,"items":{"type":"string"}},"creationTime":{"type":"string","format":"date-time","description":"The time at which the message was created"},"lastModifiedTime":{"type":"string","format":"date-time","description":"The time at which the messages was last updated"},"messageStatus":{"type":"string","description":"Current status of a message","example":"Queued","enum":["Queued","Delivered","Sent","SendingFailed","DeliveryFailed"]},"segmentCount":{"type":"integer","description":"Number of segments of a message","format":"int64","example":1},"text":{"type":"string","description":"Text of a message. Returned if the `view` parameter is set to 'Detailed'"},"cost":{"type":"number","description":"Cost of a message","format":"double","example":0.007},"direction":{"type":"string","enum":["Inbound","Outbound"],"description":"Indicates whether the message was outbound or inbound","example":"out"},"errorCode":{"type":"string","description":"The RC error code of the message sending failure reason","example":"SMS-RC-503"}},"description":"Infomation on a message returned within the specified batch"}},"paging":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"}},"description":"List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request"},"OptOutListResponse":{"type":"object","properties":{"records":{"type":"array","description":"List of individual opt-out number records","items":{"type":"object","properties":{"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the recipient has opted out","example":15551234567},"to":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format which is opted out","example":15551234567}},"description":"Opt-out record"}},"paging":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"}},"description":"Opt-out phone numbers information"},"MessageCreateRequest":{"required":["to"],"type":"object","properties":{"to":{"type":"array","description":"List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, recipients of this message. Currently only one number is supported","example":15551234567,"items":{"type":"string"}},"text":{"type":"string","description":"Text to send, maximum number of characters is 1000","example":"Hello, World!"}},"description":"Single individual SMS resource"},"MessageListMessageResponse":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message","format":"int64","example":1234},"batchId":{"type":"string","description":"Internal identifier of a batch the message was submitted in","example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message is sent","example":15551234567},"to":{"type":"array","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which a message is sent","example":15551234567,"items":{"type":"string"}},"creationTime":{"type":"string","format":"date-time","description":"The time at which the message was created"},"lastModifiedTime":{"type":"string","format":"date-time","description":"The time at which the messages was last updated"},"messageStatus":{"type":"string","description":"Current status of a message","example":"Queued","enum":["Queued","Delivered","Sent","SendingFailed","DeliveryFailed"]},"segmentCount":{"type":"integer","description":"Number of segments of a message","format":"int64","example":1},"text":{"type":"string","description":"Text of a message. Returned if the `view` parameter is set to 'Detailed'"},"cost":{"type":"number","description":"Cost of a message","format":"double","example":0.007},"direction":{"type":"string","enum":["Inbound","Outbound"],"description":"Indicates whether the message was outbound or inbound","example":"out"},"errorCode":{"type":"string","description":"The RC error code of the message sending failure reason","example":"SMS-RC-503"}},"description":"Infomation on a message returned within the specified batch"},"PagingResource":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"},"OptOutResponse":{"type":"object","properties":{"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the recipient has opted out","example":15551234567},"to":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format which is opted out","example":15551234567}},"description":"Opt-out record"}},"parameters":{"AccountId":{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}},"BatchId":{"name":"batchId","in":"path","required":true,"description":"Internal identifier of a message batch to be retrieved","example":"55577","schema":{"type":"string"}}}},"openapi":"3.0.1","security":[{"OAuth2":[]}],"servers":[{"url":"https://platform.ringcentral.com","description":"Default server"},{"url":"https://platform.devtest.ringcentral.com","description":"Sandbox server"}],"x-blacklisting-strategy":"Off","x-internal-api":false,"x-metered-api":true,"x-metering-group":"System","x-samples-enabled":true,"x-samples-ready":false,"x-send-defaults":true,"x-service-name":"pas","x-tag-groups":[{"name":"Voice","guideLink":"/guide/voice","iconName":"group_icon_voice","popular":true,"tags":["Business Hours","Call Blocking","Call Control","Call Forwarding","Call Handling Rules","Call Log","Call Monitoring Groups","Call Queues","Call Recordings","Call Recording Settings","Device SIP Registration","Greetings","IVR","RingOut","Verification Call"]},{"name":"SMS and Fax","guideLink":"/guide/messaging","iconName":"group_icon_messaging","popular":true,"tags":["Fax","Message Exports","Message Store","Pager Messages","SMS","High Volume SMS","Voicemail"]},{"name":"Team Messaging","guideLink":"/guide/team-messaging","iconName":"group_icon_glip","popular":true,"tags":["Bots","Calendar Events","Chats","Conversations","Glip Compliance Exports","Glip Contacts","Glip Internal","Glip Profile","Glip Webhooks","Notes","Posts","Tasks","Teams"]},{"name":"Meetings","guideLink":"/guide/meetings","iconName":"group_icon_meeting","popular":true,"tags":["Video","Meeting Configuration","Meeting Management","Meeting Recordings"]},{"name":"Using the API","guideLink":"/guide/basics","iconName":"group_icon_basics","tags":["Welcome","Changelog","Data Formats","Localization","Method Features"]},{"name":"Authentication","guideLink":"/guide/authentication","iconName":"group_icon_auth","tags":["OAuth 2.0"]},{"name":"Account","guideLink":"/guide/account","iconName":"group_icon_account","tags":["Company","Custom Fields","Features","Licenses","Multi-Site","Phone Numbers","Presence","Regional Settings","User Permissions","User Settings"]},{"name":"Provisioning","guideLink":"/guide","iconName":"group_icon_provisioning","tags":["Automatic Location Updates","Devices","Extensions","Paging Only Groups","Park Locations","Phone Lines","SCIM","Shared Lines","Video Configuration"]},{"name":"Address Book","guideLink":"/guide","iconName":"group_icon_address","tags":["External Contacts","Internal Contacts"]},{"name":"Roles and Permissions","tags":["Permissions","Role Management","Site Administration","User Groups"]},{"name":"Events & Notifications","guideLink":"/guide/notifications","iconName":"group_icon_notification","tags":["Subscriptions"]},{"name":"Async Requests","guideLink":"/guide","iconName":"group_icon_basics","tags":["Async Task"]},{"name":"Utilities","guideLink":"/guide","iconName":"group_icon_utilities","tags":["API Info","Application Settings"]},{"name":"Internal","tags":["ADG","Integrations","RDG"]}],"paths":{"/restapi":{"get":{"tags":["API Info"],"summary":"Get API Versions","description":"Returns current API version(s) and server info.","operationId":"readAPIVersions","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the API version"},"apiVersions":{"type":"array","description":"Full API version information: uri, number, release date","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of API versions"},"versionString":{"type":"string","description":"Version of the RingCentral REST API"},"releaseDate":{"type":"string","description":"Release date of this version"},"uriString":{"type":"string","description":"URI part determining the current version"}}}},"serverVersion":{"type":"string","description":"Server version"},"serverRevision":{"type":"string","description":"Server revision"}},"example":{"application/json":{"uri":"https://platform.ringcentral.com/restapi","apiVersions":[{"uri":"https://platform.ringcentral.com/restapi/v1.0","versionString":"1.0.34","releaseDate":"2018-02-09T00:00:00.000Z","uriString":"v1.0"}],"serverVersion":"10.0.4.7854","serverRevision":"32f2a96b769c"}}}}}}},"x-api-group":"restapi","x-auth-required":false,"x-throttling-group":"NoThrottling","x-metered-api":true,"x-metering-group":"Free","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/\n","response":"HTTP 200 OK\n\n{ \n \"uri\" : \"https://platform.ringcentral.com/restapi/\",\n \"apiVersions\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0\",\n \"versionString\" : \"1.0.36\",\n \"releaseDate\" : \"2018-04-13T00:00:00.000Z\",\n \"uriString\" : \"v1.0\"\n } ],\n \"serverVersion\" : \"10.1.4.8052\",\n \"serverRevision\" : \"a5c19499bfe7\"\n}\n"}],"x-error-codes":null}},"/restapi/{apiVersion}":{"get":{"tags":["API Info"],"summary":"Get Version Info","description":"Returns current API version info by apiVersion.","operationId":"readAPIVersion","parameters":[{"name":"apiVersion","in":"path","description":"API version to be requested, for example 'v1.0'","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"API Version","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the version info resource"},"versionString":{"type":"string","description":"Version of the RingCentral REST API"},"releaseDate":{"type":"string","description":"Release date of this version"},"uriString":{"type":"string","description":"URI part determining the current version"}},"example":{"application/json":{"uri":"https://platform.ringcentral.com/restapi/v1.0","versionString":"1.0.34","releaseDate":"2018-02-09T00:00:00.000Z","uriString":"v1.0"}}}}}}},"x-api-group":"restapi/version","x-auth-required":false,"x-throttling-group":"NoThrottling","x-metered-api":true,"x-metering-group":"Free","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0\",\n \"versionString\" : \"1.0.36\",\n \"releaseDate\" : \"2018-04-13T00:00:00.000Z\",\n \"uriString\" : \"v1.0\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"503","errorCode":"CMN-201","message":"Service Temporary Unavailable"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log":{"get":{"tags":["Call Log"],"summary":"Get User Call Log Records","description":"Returns call log records filtered by parameters specified.","operationId":"readUserCallLog","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionNumber","in":"query","description":"Extension number of a user. If specified, returns call log for a particular extension only","schema":{"type":"string"}},{"name":"showBlocked","in":"query","description":"If 'True' then calls from/to blocked numbers are returned","schema":{"type":"boolean","default":true}},{"name":"phoneNumber","in":"query","description":"Phone number of a caller/callee. If specified, returns all calls (both incoming and outcoming) with the phone number specified","schema":{"type":"string"}},{"name":"direction","in":"query","description":"The direction for the resulting records. If not specified, both inbound and outbound records are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"sessionId","in":"query","description":"Internal identifier of a session","schema":{"type":"string"}},{"name":"type","in":"query","description":"Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Voice","Fax"]}}},{"name":"transport","in":"query","description":"Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PSTN","VoIP"]}}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"withRecording","in":"query","description":"**Deprecated**. Supported for compatibility reasons. `True` if only recorded calls are returned. If both `withRecording` and `recordingType` are specified, then `withRecording` is ignored","schema":{"type":"boolean","default":false}},{"name":"recordingType","in":"query","description":"Type of a call recording. If not specified, then calls without recordings are also returned","schema":{"type":"string","enum":["Automatic","OnDemand","All"]}},{"name":"dateTo","in":"query","description":"The end datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time","schema":{"type":"string","format":"date-time"}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours","schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"showDeleted","in":"query","description":"If 'True' then deleted calls are returned","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/call-log","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"ReadExtensionCallLog","x-docs-level":"Public","x-http-examples":[{"title":"Simple View","request":"GET /restapi/v1.0/account/~/extension/~/call-log?page=1&perPage=2&view=Simple\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/call-log?view=Simple&showBlocked=true&dateFrom=2017-09-03T12:34:00.000Z&page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/call-log/IWvNToLkbo-7zUA?view=Simple\",\n \"id\" : \"IWvNToLkbo-7zUA\",\n \"sessionId\" : \"404036325008\",\n \"telephonySessionId\": \"z-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-09-04T12:31:50.441Z\",\n \"duration\" : 5,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"RingOut Web\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16505556678\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552001907\",\n \"name\" : \"John Smith\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/call-log/8vsAH84JRCeg-DLA?view=Simple\",\n \"id\" : \"8vsAH84JRCeg-DLA\",\n \"sessionId\" : \"40293491700800\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-09-04T12:03:24.842Z\",\n \"duration\" : 32,\n \"type\" : \"Fax\",\n \"direction\" : \"Outbound\",\n \"action\" : \"Outgoing Fax\",\n \"result\" : \"Sent\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552001907\",\n \"name\" : \"John Smith\"\n },\n \"message\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/message-store/401678422008\",\n \"id\" : \"401678422008\",\n \"type\" : \"Fax\"\n }\n }],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/call-log?view=Simple&showBlocked=true&dateFrom=2017-09-03T12:34:00.000Z&page=2&perPage=2\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401494647008/extension/401494647008/call-log?view=Simple&showBlocked=true&dateFrom=2017-09-03T12:34:00.000Z&page=1&perPage=2\"\n }\n }\n}\n"},{"title":"Detailed View","request":"GET /restapi/v1.0/account/~/extension/1423308004/call-log?view=Detailed\n","response":"{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log?view=Detailed&showBlocked=true&withRecording=false&dateFrom=2018-06-14T13:28:00.000Z&page=1&perPage=2\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log/IyQAmlV2ORKZzUA?view=Detailed\",\n \"id\": \"IyQAmlV2ORKZzUA\",\n \"sessionId\": \"424824200008\",\n \"telephonySessionId\": \"u-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2018-06-14T23:16:33.000Z\",\n \"duration\": 4,\n \"type\": \"Voice\",\n \"direction\": \"Inbound\",\n \"action\": \"Phone Call\",\n \"result\": \"Accepted\",\n \"to\": {\n \"phoneNumber\": \"+18442374550\",\n \"name\": \"John Smith\"\n },\n \"from\": {\n \"phoneNumber\": \"+16504445567\",\n \"name\": \"Jane Smith\",\n \"location\": \"Palo Alto, CA\"\n },\n \"transport\": \"PSTN\",\n \"lastModifiedTime\": \"2018-06-14T23:16:36.006Z\",\n \"billing\": {\n \"costIncluded\": 1.26,\n \"costPurchased\": 2.222\n },\n \"legs\": [\n {\n \"startTime\": \"2018-06-14T23:16:33.000Z\",\n \"duration\": 4,\n \"type\": \"Voice\",\n \"direction\": \"Inbound\",\n \"action\": \"Phone Call\",\n \"result\": \"Accepted\",\n \"to\": {\n \"phoneNumber\": \"+18442374550\",\n \"name\": \"John Smith\"\n },\n \"from\": {\n \"phoneNumber\": \"+16504445567\",\n \"name\": \"Jane Smith\",\n \"location\": \"Palo Alto, CA\"\n },\n \"transport\": \"PSTN\",\n \"legType\": \"Accept\",\n \"extension\": {\n \"uri\": \"http://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008\",\n \"id\": 416095514008\n },\n \"master\": true\n }\n ]\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log/IyQAlMhgV5xxzUA?view=Detailed\",\n \"id\": \"IyQAlMhgV5xxzUA\",\n \"sessionId\": \"424824196008\",\n \"telephonySessionId\": \"a-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2018-06-14T23:16:33.000Z\",\n \"duration\": 10,\n \"type\": \"Voice\",\n \"direction\": \"Outbound\",\n \"action\": \"VoIP Call\",\n \"result\": \"Call connected\",\n \"to\": {\n \"phoneNumber\": \"+16505556678\"\n },\n \"from\": {\n \"phoneNumber\": \"+18442374550\",\n \"name\": \"John Smith\"\n },\n \"transport\": \"VoIP\",\n \"lastModifiedTime\": \"2018-06-14T23:16:35.005Z\",\n \"billing\": {\n \"costIncluded\": 0,\n \"costPurchased\": 0\n },\n \"legs\": [\n {\n \"startTime\": \"2018-06-14T23:16:33.000Z\",\n \"duration\": 10,\n \"type\": \"Voice\",\n \"direction\": \"Outbound\",\n \"action\": \"VoIP Call\",\n \"result\": \"Call connected\",\n \"to\": {\n \"phoneNumber\": \"+16505556678\"\n },\n \"from\": {\n \"phoneNumber\": \"+18442374550\",\n \"name\": \"John Smith\"\n },\n \"transport\": \"VoIP\",\n \"legType\": \"SipToPstnMetered\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008\",\n \"id\": 416095514008\n },\n \"master\": true\n }\n ]\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"perPage\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"nextPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log?view=Detailed&showBlocked=true&withRecording=false&dateFrom=2018-06-14T13:28:00.000Z&page=2&perPage=2\"\n },\n \"firstPage\": {\n \"uri\": \"https//platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log?view=Detailed&showBlocked=true&withRecording=false&dateFrom=2018-06-14T13:28:00.000Z&page=1&perPage=2\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416095514008/extension/416095514008/call-log?view=Detailed&showBlocked=true&withRecording=false&dateFrom=2018-06-14T13:28:00.000Z&page=1&perPage=2\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [view] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadCallLog] permission granted with extended scope"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"delete":{"tags":["Call Log"],"summary":"Delete User Call Log","description":"Deletes filtered call log records.","operationId":"deleteUserCallLog","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"dateTo","in":"query","description":"The end datetime for records deletion in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time","schema":{"type":"string","format":"date-time"}},{"name":"phoneNumber","in":"query","schema":{"type":"string"}},{"name":"extensionNumber","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Voice","Fax"]}}},{"name":"direction","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"dateFrom","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"default":{"description":"Success","content":{}}},"x-api-group":"extension/call-log","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditCallLog","x-user-permission":"EditCallLog","x-feature":"EditExtensionCallLog","x-docs-level":"Public","x-availability":"Limited","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/extension/~/call-log?dateTo=2012-09-17T13:51:00.000Z\n","response":"204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync":{"get":{"tags":["Call Log"],"summary":"Sync User Call Log","description":"Synchronizes call log records.","operationId":"syncUserCallLog","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"syncType","in":"query","description":"Type of synchronization","schema":{"type":"string","default":"FSync","enum":["FSync","ISync"]}},{"name":"syncToken","in":"query","description":"Value of syncToken property of last sync request response","schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment","schema":{"type":"string","format":"date-time"}},{"name":"recordCount","in":"query","description":"For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250","schema":{"type":"integer"}},{"name":"statusGroup","in":"query","description":"Type of calls to be returned. The default value is 'All'","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Missed","All"]}}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"showDeleted","in":"query","description":"Supported for ISync. If 'True' then deleted call records are returned","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of call log records with sync information"},"records":{"type":"array","description":"List of call log records with synchronization information. For ISync the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"The last synchronization datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}},"description":"Sync information (type, token and time)"}}}}}}},"x-api-group":"extension/call-log-sync","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"ReadExtensionCallLog","x-docs-level":"Public","x-http-examples":[{"title":"Full Sync","request":"GET /restapi/v1.0/account/~/extension/~/call-log-sync?statusGroup=All&syncType=FSync&recordCount=3\n","response":"{\n \"uri\": \"http://platform.ringcentral.com/restapi/v1.0/account/416562555008/extension/416562555008/call-log-sync?statusGroup=All&syncType=FSync&recordCount=3\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416562555008/extension/416562555008/call-log/IzbM55lBt9RjzUA?view=Simple\",\n \"id\": \"IzbM55lBt9RjzUA\",\n \"sessionId\": \"425711913008\",\n \"telephonySessionId\": \"k-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2018-06-18T14:02:01.000Z\",\n \"duration\": 4,\n \"type\": \"Voice\",\n \"direction\": \"Inbound\",\n \"action\": \"Phone Call\",\n \"result\": \"Accepted\",\n \"to\": {\n \"phoneNumber\": \"+18664178108\",\n \"name\": \"Jane Smith\"\n },\n \"from\": {\n \"phoneNumber\": \"+16504445567\",\n \"name\": \"John Smith\",\n \"location\": \"Palo Alto, CA\"\n }\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416562555008/extension/416562555008/call-log/IzbMwL2ojZlLzUA?view=Simple\",\n \"id\": \"IzbMwL2ojZlLzUA\",\n \"sessionId\": \"425711885008\",\n \"telephonySessionId\": \"r-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2018-06-18T14:01:58.000Z\",\n \"duration\": 10,\n \"type\": \"Voice\",\n \"direction\": \"Outbound\",\n \"action\": \"VoIP Call\",\n \"result\": \"Call connected\",\n \"to\": {\n \"phoneNumber\": \"+16505556678\"\n },\n \"from\": {\n \"phoneNumber\": \"+18664178108\",\n \"name\": \"Jane Smith\"\n }\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/416562555008/extension/416562555008/call-log/IzbMvJPYJICtzUA?view=Simple\",\n \"id\": \"IzbMvJPYJICtzUA\",\n \"sessionId\": \"425711882008\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2018-06-18T14:01:58.000Z\",\n \"duration\": 10,\n \"type\": \"Voice\",\n \"direction\": \"Outbound\",\n \"action\": \"VoIP Call\",\n \"result\": \"Call connected\",\n \"to\": {\n \"phoneNumber\": \"+16504445567\",\n \"location\": \"Palo Alto, CA\"\n },\n \"from\": {\n \"phoneNumber\": \"+18664178108\",\n \"name\": \"Jane Smith\"\n }\n }\n ],\n \"syncInfo\": {\n \"syncType\": \"FSync\",\n \"syncToken\": \"FAsDAwAAAWQTM3nQBAAAAWQTNpOmCAAAAGD9ECiADQAAAGMeZ88YDgAAAWQTM3nQEQAaADEANQAyADkAMwAzADAANQAxADgAMAAwADAAXwA0ADIANQA3ADEAMQA4ADgAMgAwADAAOBIAAAFkEzaTphQBFQAYAOZ2alQ\",\n \"syncTime\": \"2018-06-18T14:05:01.223Z\"\n }\n}\n"},{"title":"Incremental Sync","request":"GET /restapi/v1.0/account/~/extension/~/call-log-sync?syncType=ISync&syncToken=FAsDAwAAAT8KnL6gBAAAAT8KpCkQCAAAAF0q3WVgCQEKAQwAAAAeDQAAAF3UKlK4Y1WS_Q\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/3107276004/extension/3107276004/call-log-sync?syncType=ISync&syncToken=FAsDAwAAAVcPoglgBAAAAVcPpGB3CAAAAAC5NUTkCQEKAQ0AAAAB-PhS3A4AAAFXD6IJYA8CEQARADEANAA3ADMANAAzADYAMAA2ADAAMAAwADAAXwAwAF8AMBIAAAFXD6RgdxQBFQEyXlFP&recordCount=10\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/account/400151109008/extension/400151111008/call-log/IVWtULXC0ONbNRE\",\n \"id\" : \"IVWtULXC0ONbNRE\",\n \"startTime\" : \"2016-09-09T16:00:57.000Z\",\n \"duration\" : 16,\n \"direction\" : \"Outbound\",\n \"type\": \"Voice\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+12052160010\",\n \"name\" : \"Allen\",\n \"location\" : \"Alabaster, AL\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+17435637778\",\n \"name\" : \"Steven\"\n }\n }],\n \"syncInfo\" : {\n \"syncType\" : \"ISync\",\n \"syncToken\" : \"FAsDAwAAAVcPoglgBAAAAVcPpGB3CAAAAAC5NUTkCQEKAQ0AAAAB-PhS3A4AAAFXD6IJYA8CEQARADEANAA3ADMANAAzADYAMAA2ADAAMAAwADAAXwAwAF8AMBIAAAFXD7s9shQBFQEyLcHq\",\n \"syncTime\" : \"2016-09-09T16:40:11.794Z\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CLG-104","message":"Parameter [syncToken] is invalid [Sync token expired, call log was reset]"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [recordCount] value is invalid."}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}":{"get":{"tags":["Call Log"],"summary":"Get User Call Record","description":"Returns call log records by ID.","operationId":"readUserCallRecord","parameters":[{"name":"callRecordId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"view","in":"query","description":"View of call records. The view value specified for 'FSync' will also be applied for 'ISync' by default, since it cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Call Log Record","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}}}}},"x-api-group":"extension/call-log","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"ReadExtensionCallLog","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/401190149008/extension/401190149008/call-log/IXPCm_tIkCduk4I\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401190149008/extension/401190149008/call-log/IXPCm_tIkCduk4I?view=Simple\",\n \"id\": \"IXPCm_tIkCduk4I\",\n \"sessionId\": \"404412141008\",\n \"telephonySessionId\": \"b-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\": \"2015-06-25T14:57:30.000Z\",\n \"duration\": 60,\n \"type\": \"Voice\",\n \"direction\": \"Inbound\",\n \"action\": \"Phone Call\",\n \"result\": \"Accepted\",\n \"to\": {\n \"phoneNumber\": \"+18772160007\",\n \"name\": \"John Smith\"\n },\n \"from\": {\n \"phoneNumber\": \"+18882400004\",\n \"name\": \"Jane Smith\"\n },\n \"recording\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401190149008/recording/401547458008\",\n \"id\": \"401547458008\",\n \"type\": \"OnDemand\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/401190149008/recording/401547458008/content\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadCallLog] permission granted with extended scope"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls":{"get":{"tags":["Call Log"],"summary":"Get User Active Calls","description":"Returns records of all extension calls that are in progress, ordered by start time in descending order.","operationId":"listExtensionActiveCalls","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"direction","in":"query","description":"The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"type","in":"query","description":"Call type of a record. If not specified, all call types are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Voice","Fax"]}}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of user active call records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"transport":{"type":"string","description":"For 'Detailed' view only. Call transport","enum":["PSTN","VoIP"]},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"duration":{"type":"integer","description":"Call duration in seconds"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again\n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/active-calls","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"ReadExtensionCallLog","x-docs-level":"Public","x-availability":"Limited","x-http-examples":[{"title":"Simple View","request":"GET /restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Simple\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Simple&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/call-log/XYqB_atHFKbNQA?view=Simple\",\n \"id\" : \"XYqB_atHFKbNQA\",\n \"sessionId\" : \"4417351004\",\n \"telephonySessionId\": \"x-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-10T13:43:13.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"RingOut Web\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18552055108\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"name\" : \"John Smith\"\n }\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 100,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Simple&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Simple&page=1&perPage=100\"\n }\n }\n}\n"},{"title":"Detailed View","request":"GET /restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Detailed\n``` \n### Response\n```HTTP\nHTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Detailed&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/call-log/XYqI7gag6FjNQA?view=Detailed\",\n \"id\" : \"XYqI7gag6FjNQA\",\n \"sessionId\" : \"4417356004\",\n \"telephonySessionId\": \"o-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-10T13:44:51.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"RingOut Web\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18552055108\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"name\" : \"John Smith\"\n },\n \"legs\" : [ {\n \"startTime\" : \"2018-09-10T13:44:51.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"RingOut Web\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18552055108\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"name\" : \"John Smith\"\n },\n \"legType\" : \"RingOutWebToSubscriber\",\n \"master\" : true\n } ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 100,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Detailed&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1414236004/extension/1414236004/active-calls?view=Detailed&page=1&perPage=100\"\n }\n }\n}\n","response":""},{"title":"Full Synchronization","request":"GET /restapi/v1.0/account/403454965008/call-log-sync?recordCount=3&syncType=FSync&statusGroup=All\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log-sync?statusGroup=All&syncType=FSync&recordCount=3\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lZ5GvINC3zUA?view=Simple\",\n \"id\" : \"Ii6lZ5GvINC3zUA\",\n \"sessionId\" : \"413237579008\",\n \"telephonySessionId\": \"l-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:48.000Z\",\n \"duration\" : 4,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18772000394\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lZi5pqHMtzUA?view=Simple\",\n \"id\" : \"Ii6lZi5pqHMtzUA\",\n \"sessionId\" : \"413237578008\",\n \"telephonySessionId\": \"q-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:48.000Z\",\n \"duration\" : 5,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552000384\",\n \"name\" : \"Jane Smith\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lYgSZP1qPzUA?view=Simple\",\n \"id\" : \"Ii6lYgSZP1qPzUA\",\n \"sessionId\" : \"413237575008\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:45.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16505556678\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18772000394\",\n \"name\" : \"John Smith\"\n }\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"FSync\",\n \"syncToken\" : \"GQsDAwAAAV86NtGABAAAAV86OMdhCAAAAF3vyjUQDQA\",\n \"syncTime\" : \"2017-10-20T14:38:40.481Z\"\n }\n }\n"},{"title":"Incremental Synchronization","request":"GET /restapi/v1.0/account/403454965008/call-log-sync?recordCount=5&syncType=ISync&syncToken=GQsDAwAAAV86NtGABAAAAV86OMdhCAAAAF3vyjUQDQA\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log-sync?syncType=ISync&syncToken=GQsDAwAAAV86NtGABAAAAV86OMdhCAAAAF3vyjUQDQA&recordCount=5\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lXdrI1kHxzUA?view=Simple\",\n \"id\" : \"Ii6lXdrI1kHxzUA\",\n \"sessionId\" : \"413237572008\",\n \"telephonySessionId\": \"d-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:45.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18772000394\",\n \"name\" : \"John Smith\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lWbD4bSlTzUA?view=Simple\",\n \"id\" : \"Ii6lWbD4bSlTzUA\",\n \"sessionId\" : \"413237569008\",\n \"telephonySessionId\": \"c-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:45.000Z\",\n \"duration\" : 7,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18772000394\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"location\" : \"Palo Alto, CA\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lWE2y9MvJzUA?view=Simple\",\n \"id\" : \"Ii6lWE2y9MvJzUA\",\n \"sessionId\": \"413237568008\",\n \"telephonySessionId\": \"j-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:45.000Z\",\n \"duration\" : 3,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552000384\",\n \"name\" : \"Jane Smith\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lVCPii7MrzUA?view=Simple\",\n \"id\" : \"Ii6lVCPii7MrzUA\",\n \"sessionId\" : \"413237565008\",\n \"telephonySessionId\": \"m-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:45.000Z\",\n \"duration\" : 3,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18002000332\",\n \"name\" : \"Fred Grey\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403454965008/call-log/Ii6lT_oSIpqNzUA?view=Simple\",\n \"id\" : \"Ii6lT_oSIpqNzUA\",\n \"sessionId\" : \"413237562008\",\n \"telephonySessionId\": \"u-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-10-20T14:36:42.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16505556677\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18772000394\",\n \"name\" : \"John Smith\"\n }\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"ISync\",\n \"syncToken\" : \"GQsDAwAAAV86NtGABAAAAV86OX1RCAAAAF3vyjUQDQA\",\n \"syncTime\" : \"2017-10-20T14:39:27.058Z\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/call-log":{"get":{"tags":["Call Log"],"summary":"Get Company Call Log Records","description":"Returns call log records filtered by parameters specified.","operationId":"readCompanyCallLog","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionNumber","in":"query","description":"Extension number of a user. If specified, returns call log for a particular extension only","schema":{"type":"string"}},{"name":"phoneNumber","in":"query","description":"Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the phone number specified. Cannot be specified together with the extensionNumber filter","schema":{"type":"string"}},{"name":"direction","in":"query","description":"The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"type","in":"query","description":"Call type of a record. If not specified, all call types are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Voice","Fax"]}}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"withRecording","in":"query","description":"**Deprecated**. Supported for compatibility reasons only. `true` if only recorded calls are returned. The default value is `false`. If both `withRecording` and `recordingType` are specified, `withRecording` is ignored","schema":{"type":"boolean"}},{"name":"recordingType","in":"query","description":"Type of a call recording. If not specified, then calls without recordings are also returned","schema":{"type":"string","enum":["Automatic","OnDemand","All"]}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours","schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"The end datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time","schema":{"type":"string","format":"date-time"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"sessionId","in":"query","description":"Internal identifier of a call session","schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of company call log records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-log","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"FullCompanyCallLog","x-feature":"ReadAccountCallLog","x-docs-level":"Public","x-http-examples":[{"title":"Simple View","request":"GET /restapi/v1.0/account/400643090008/call-log?view=Simple&dateFrom=2015-11-24T12:07:53.175Z&dateTo=2015-11-25T12:07:53.175Z&page=1&perPage=2\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400643090008/call-log?view=Simple&dateFrom=2015-11-24T12:07:53.175Z&dateTo=2015-11-25T12:07:53.175Z&page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400643090008/call-log/IWM7cJogEv7xlu8?view=Simple\",\n \"id\" : \"IWM7cJogEv7xlu8\",\n \"sessionId\" : \"403631628008\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2015-11-25T12:07:51.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16505556678\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18883930031\",\n \"name\" : \"John Smith\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400643090008/call-log/IWM7bHBPqeZTlu8?view=Simple\",\n \"id\" : \"IWM7bHBPqeZTlu8\",\n \"sessionId\" : \"403631625008\",\n \"telephonySessionId\": \"t-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2015-11-25T12:07:51.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18883930031\",\n \"name\" : \"John Smith\"\n }\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400643090008/call-log?view=Simple&dateFrom=2015-11-24T12:07:53.175Z&dateTo=2015-11-25T12:07:53.175Z&page=2&perPage=2\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400643090008/call-log?view=Simple&dateFrom=2015-11-24T12:07:53.175Z&dateTo=2015-11-25T12:07:53.175Z&page=1&perPage=2\"\n }\n } \n}\n"},{"title":"Detailed View","request":"GET /restapi/v1.0/account/404350835008/call-log?dateFrom=2016-11-24T12%3A07%3A53.175Z&dateTo=2017-11-24T12%3A07%3A53.175Z&page=1&perPage=2&view=Detailed\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/call-log?view=Detailed&showBlocked=true&dateFrom=2016-11-24T12:07:53.175Z&dateTo=2017-11- 24T12:07:53.175Z&page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/call-log/IaDUlfiF_23aKtI?view=Detailed\",\n \"id\" : \"IaDUlfiF_23aKtI\",\n \"sessionId\" : \"406540522008\",\n \"telephonySessionId\": \"v-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-04-06T11:19:54.000Z\",\n \"duration\" : 4,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18882011073\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"transport\" : \"PSTN\",\n \"lastModifiedTime\" : \"2017-04-06T11:19:57.001Z\",\n \"billing\" : {\n \"costIncluded\" : 1.560,\n \"costPurchased\" : 1.122\n },\n \"legs\" : [ {\n \"startTime\" : \"2017-04-06T11:19:54.000Z\",\n \"duration\" : 4,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18882011073\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"transport\" : \"PSTN\",\n \"billing\" : {\n \"costIncluded\" : 0.300,\n \"costPurchased\" : 0.000\n },\n \"legType\" : \"Accept\"\n }, {\n \"startTime\" : \"2017-04-06T11:19:54.000Z\",\n \"duration\" : 4,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18882011073\",\n \"name\" : \"John Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"name\" : \"Jane Smith\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"transport\" : \"PSTN\",\n \"billing\" : {\n \"costIncluded\" : 1.260,\n \"costPurchased\" : 1.222\n },\n \"legType\" : \"Accept\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/404350835008/extension/404350835008\",\n \"id\" : 404350835008\n }\n } ]\n }, {\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/call-log/IaDUlJVAhxBQKtI?view=Detailed\",\n \"id\" : \"IaDUlJVAhxBQKtI\",\n \"sessionId\" : \"406540521008\",\n \"telephonySessionId\": \"w-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2017-04-06T11:19:54.000Z\",\n \"duration\" : 5,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552011120\",\n \"name\" : \"John Doe\"\n },\n \"transport\" : \"VoIP\",\n \"lastModifiedTime\" : \"2017-04-06T11:19:57.001Z\",\n \"billing\" : {\n \"costIncluded\" : 0.340,\n \"costPurchased\" : 0.025\n },\n \"legs\" : [ {\n \"startTime\" : \"2017-04-06T11:19:54.000Z\",\n \"duration\" : 5,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18552011120\",\n \"name\" : \"John Doe\"\n },\n \"transport\" : \"VoIP\",\n \"billing\" : {\n \"costIncluded\" : 0.340,\n \"costPurchased\" : 0.025\n },\n \"legType\" : \"SipToPstnMetered\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/extension/404350837008\",\n \"id\" : 404350837008\n }\n } ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/call-log?view=Detailed&showBlocked=true&dateFrom=2016-11-24T12:07:53.175Z&dateTo=2017-11-24T12:07:53.175Z&page=2&perPage=2\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/account/404350835008/call-log?view=Detailed&showBlocked=true&dateFrom=2016-11-24T12:07:53.175Z&dateTo=2017-11-24T12:07:53.175Z&page=1&perPage=2\"\n }\n }\n\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [view] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/call-log-sync":{"get":{"tags":["Call Log"],"summary":"Sync Company Call Log","description":"Synchronizes company call log records.","operationId":"syncAccountCallLog","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"syncType","in":"query","description":"Type of synchronization.","schema":{"type":"string","default":"FSync","enum":["FSync","ISync"]}},{"name":"syncToken","in":"query","description":"Value of syncToken property of last sync request response","schema":{"type":"string"}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting records in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment","schema":{"type":"string","format":"date-time"}},{"name":"recordCount","in":"query","description":"For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync frame to the past, the maximum number of records is 250","schema":{"type":"integer"}},{"name":"statusGroup","in":"query","description":"Type of calls to be returned.","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"},"enum":["Missed","All"]}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"showDeleted","in":"query","description":"Supported for ISync. If 'True' then deleted call records are returned","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to account call log sync resource"},"records":{"type":"array","description":"List of call log records with synchronization information. For 'ISync' the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Time of last synchronization in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example *2016-03-10T18:07:52.534Z*"}},"description":"Sync information (type, token and time)"}}}}}}},"x-api-group":"account/call-log-sync","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"ReadAccountCallLog","x-docs-level":"Public","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-log/{callRecordId}":{"get":{"tags":["Call Log"],"summary":"Get Company Call Log Record(s)","description":"Returns individual call log record(s) by ID(s). Batch request is supported.","operationId":"readCompanyCallRecord","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"callRecordId","in":"path","description":"Internal identifier of a call log record","required":true,"schema":{"type":"string"}},{"name":"view","in":"query","description":"View of call records. The view value specified for 'FSync' will also be applied for 'ISync' by default, since it cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}}}}},"x-api-group":"account/call-log","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"FullCompanyCallLog","x-feature":"ReadAccountCallLog","x-docs-level":"Public","x-http-examples":[{"title":"Single Record (Detailed View)","request":"GET /restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AvJPtwNQbNQA?view=Detailed\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AvJPtwNQbNQA?view=Detailed\",\n \"id\" : \"X2AvJPtwNQbNQA\",\n \"sessionId\" : \"4503991004\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T13:24:09.000Z\",\n \"duration\" : 7,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019834\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"name\" : \"John Smith\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n \"id\" : 1477535004\n },\n \"transport\" : \"PSTN\",\n \"lastModifiedTime\" : \"2018-09-11T13:24:12.003Z\",\n \"billing\" : {\n \"costIncluded\" : 0.000,\n \"costPurchased\" : 0.000\n },\n \"legs\" : [ {\n \"startTime\" : \"2018-09-11T13:24:09.000Z\",\n \"duration\" : 7,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019834\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445566\",\n \"name\" : \"John Smith\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n \"id\" : 1477535004\n },\n \"transport\" : \"PSTN\",\n \"legType\" : \"Accept\",\n \"master\" : true\n } ] \n}\n"},{"title":"Multiple Records (Simple View)","request":"GET /restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2A9BbIj3GrNQA, X2AlbhUlpkDNQA?view=Simple\n","response":"HTTP 200 OK\n--Boundary_6_695025702_1536675000681\nContent-Type: application/json\n\n{\n \"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2A9BbIj3GrNQA?view=Simple\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AlbhUlpkDNQA?view=Simple\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n } ]\n}\n--Boundary_6_695025702_1536675000681\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2A9BbIj3GrNQA?view=Simple\",\n \"id\" : \"X2A9BbIj3GrNQA\",\n \"sessionId\" : \"4504001004\",\n \"telephonySessionId\": \"f-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T13:24:12.000Z\",\n \"duration\" : 4,\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"Accepted\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019834\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16504445567\",\n \"name\" : \"Julia Rose\",\n \"location\" : \"Palo Alto, CA\"\n },\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n \"id\" : 1477535004\n }\n}\n--Boundary_6_695025702_1536675000681\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004/call-log/X2AlbhUlpkDNQA?view=Simple\",\n \"id\" : \"X2AlbhUlpkDNQA\",\n \"sessionId\" : \"4503984004\",\n \"telephonySessionId\": \"s-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T13:24:06.000Z\",\n \"duration\" : 10,\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"VoIP Call\",\n \"result\" : \"Call connected\",\n \"to\" : {\n \"phoneNumber\" : \"+16505556677\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+18662019834\",\n \"name\" : \"Jane Smith\"\n },\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477535004/extension/1477535004\",\n \"id\" : 1477535004\n }\n}\n--Boundary_6_695025702_1536675000681--\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/active-calls":{"get":{"tags":["Call Log"],"summary":"Get Company Active Calls","description":"Returns records of all calls that are in progress, ordered by start time in descending order.","operationId":"listCompanyActiveCalls","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"direction","in":"query","description":"The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"view","in":"query","description":"View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"type","in":"query","description":"Call type of a record. If not specified, all call types are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Voice","Fax"]}}},{"name":"transport","in":"query","description":"Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["PSTN","VoIP"]}}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of company active call records"},"records":{"type":"array","description":"List of call log records","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a cal log record"},"uri":{"type":"string","description":"Canonical URI of a call log record"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"deleted":{"type":"boolean","description":"Indicates whether the record is deleted. Returned for deleted records, for ISync requests"},"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Login","Calling Card","VoIP Call","Phone Call","Paging","Hunting","Call Park","Monitoring","Text Relay","External Application","Park Location","CallOut-CallMe","Conference Call","Move","RC Meetings","Accept Call","FindMe","FollowMe","RingMe","Transfer","Call Return","Ring Directly","RingOut Web","RingOut PC","RingOut Mobile","Emergency","E911 Update","Support","Incoming Fax","Outgoing Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"duration":{"type":"integer","description":"Call duration in seconds"},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"legs":{"type":"array","description":"For 'Detailed' view only. Leg description","items":{"type":"object","properties":{"action":{"type":"string","description":"Action description of the call operation","enum":["Unknown","Phone Call","Phone Login","Incoming Fax","Accept Call","External Application","FindMe","FollowMe","Outgoing Fax","CallOut-CallMe","Call Return","Calling Card","Monitoring","Ring Directly","RingOut Web","Text Relay","VoIP Call","RingOut PC","RingMe","Transfer","411 Info","Emergency","E911 Update","Support","RingOut Mobile","MeetingsCall","SilentMonitoring"]},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"delegate":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a Secretary extension"},"name":{"type":"string","description":"Custom name of a Secretary extension"}},"description":"Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"duration":{"type":"integer","description":"Call duration in seconds"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"}},"description":"Information on extension"},"legType":{"type":"string","description":"Leg type","enum":["SipForwarding","ServiceMinus2","ServiceMinus3","PstnToSip","Accept","FindMe","FollowMe","TestCall","FaxSent","CallBack","CallingCard","RingDirectly","RingOutWebToSubscriber","RingOutWebToCaller","SipToPstnMetered","RingOutClientToSubscriber","RingOutClientToCaller","RingMe","TransferCall","SipToPstnUnmetered","RingOutDeviceToSubscriber","RingOutDeviceToCaller","RingOutOneLegToCaller","ExtensionToExtension","CallPark","PagingServer","Hunting","OutgoingFreeSpDl","ParkLocation","ConferenceCall","MobileApp","Monitoring","MoveToConference","Unknown"]},"startTime":{"type":"string","description":"The call start datetime in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"type":{"type":"string","description":"Call type","enum":["Voice","Fax"]},"result":{"type":"string","description":"Status description of the call operation","enum":["Unknown","Accepted","Call connected","In Progress","Voicemail","Reply","Missed","Busy","Rejected","No Answer","Hang Up","Blocked","Suspended account","Call Failed","Call Failure","Internal Error","IP Phone Offline","No Calling Credit","Not Allowed","Restricted Number","Wrong Number","Answered Not Accepted","Stopped","International Disabled","International Restricted","Abandoned","Declined","Received","Fax on Demand","Partial Receive","Receive Error","Fax Receipt Error","Sent","Fax Partially Sent","Send Error","Fax Not Sent","Fax Poor Line"]},"reason":{"type":"string","description":"Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n","enum":["Accepted","Connected","line Busy","Not Answered","No Answer","Hang Up","Stopped","Internal Error","No Credit","Restricted Number","Wrong Number","International Disabled","International Restricted","Bad Number","Info 411 Restricted","Customer 611 Restricted","No Digital Line","Failed Try Again","Max Call Limit","Too Many Calls","Calls Not Accepted","Number Not Allowed","Number Blocked","Number Disabled","Not Allowed","Resource Error","Call Loop","Fax Not Received","Fax Partially Sent","Fax Not Sent","Fax Poor Line","Fax Prepare Error","Fax Save Error","Fax Send Error"]},"reasonDescription":{"type":"string"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"string to a device"}}}},"description":"Information on caller ('from') or callee ('to')"},"transport":{"type":"string","description":"Call transport","enum":["PSTN","VoIP"]},"recording":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the call recording"},"uri":{"type":"string","description":"Link to the call recording metadata resource"},"type":{"type":"string","description":"Indicates recording mode used","enum":["Automatic","OnDemand"]},"contentUri":{"type":"string","description":"Link to the call recording binary content"}},"description":"Call recording data. Returned if the call is recorded - `withRecording` parameter is set to 'True' in this case"},"shortRecording":{"type":"boolean","description":"Indicates that the recording is too short and therefore wouldn't be returned. The flag is not returned if the value is false"},"master":{"type":"boolean","description":"Returned for 'Detailed' call log. Specifies if the leg is master-leg"},"message":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"type":{"type":"string","description":"Type of a message"},"uri":{"type":"string","description":"Link to a message resource"}},"description":"Linked message (Fax/Voicemail)"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"}}}},"billing":{"type":"object","properties":{"costIncluded":{"type":"number","description":"Cost per minute, paid and already included in your RingCentral Plan. For example International Calls"},"costPurchased":{"type":"number","description":"Cost per minute, paid and not included in your RingCentral Plan"}},"description":"Billing information related to the call. Returned for 'Detailed' view only"},"lastModifiedTime":{"type":"string","description":"For 'Detailed' view only. The datetime when the call log record was modified in (ISO 8601)[https://en.wikipedia.org/wiki/ISO_8601] format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/active-calls","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallLog","x-user-permission":"ReadCallLog","x-feature":"EditAccountCallLog","x-docs-level":"Public","x-availability":"Limited","x-http-examples":[{"title":"Simple View","request":"GET /restapi/v1.0/account/1477660004/active-calls?view=Simple\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Simple&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/extension/1477660004/call-log/X2I0yTPQfxjNQA?view=Simple\",\n \"id\" : \"X2I0yTPQfxjNQA\",\n \"sessionId\" : \"4504364004\",\n \"telephonySessionId\": \"n-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T15:00:15.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019836\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16316761623\",\n \"location\" : \"Ronkonkoma, NY\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/extension/1477660004/call-log/X2IzZe5YIY7NQA?view=Simple\",\n \"id\" : \"X2IzZe5YIY7NQA\",\n \"sessionId\" : \"4504363004\",\n \"telephonySessionId\": \"h-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T15:00:15.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Outbound\",\n \"action\" : \"RingOut Web\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019836\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"name\" : \"John Smith\"\n }\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 100,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Simple&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Simple&page=1&perPage=100\"\n }\n }\n}\n \n\n"},{"title":"Detailed View","request":"GET /restapi/v1.0/account/1477660004/active-calls?perPage=1&view=Detailed\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Detailed&page=1&perPage=1\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/extension/1477660004/call-log/X2IFmfnUEsTNQA?view=Detailed\",\n \"id\" : \"X2IFmfnUEsTNQA\",\n \"sessionId\" : \"4504330004\",\n \"telephonySessionId\": \"h-9a03590172ea4d39a7cf7d5b6dba6a3b\",\n \"startTime\" : \"2018-09-11T14:48:31.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019836\",\n \"name\" : \"John Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16316761623\",\n \"location\" : \"Ronkonkoma, NY\"\n },\n \"legs\" : [ {\n \"startTime\" : \"2018-09-11T14:48:31.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019836\",\n \"name\" : \"Jane Smith\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16316761623\",\n \"location\" : \"Ronkonkoma, NY\"\n },\n \"legType\" : \"Accept\",\n \"master\" : true\n }, {\n \"startTime\" : \"2018-09-11T14:48:31.000Z\",\n \"type\" : \"Voice\",\n \"direction\" : \"Inbound\",\n \"action\" : \"Phone Call\",\n \"result\" : \"In Progress\",\n \"to\" : {\n \"phoneNumber\" : \"+18662019836\",\n \"name\" : \"Something New\"\n },\n \"from\" : {\n \"phoneNumber\" : \"+16316761623\",\n \"location\" : \"Ronkonkoma, NY\"\n },\n \"legType\" : \"Accept\",\n \"master\" : false\n } ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"perPage\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Detailed&page=2&perPage=1\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Detailed&page=1&perPage=1\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1477660004/active-calls?view=Detailed&page=1&perPage=1\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/recording/{recordingId}":{"get":{"tags":["Call Recordings"],"summary":"Get Call Recording","description":"Returns call recordings by ID(s).","operationId":"readCallRecording","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"recordingId","in":"path","description":"Internal identifier of a recording (returned in Call Log)","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call recording"},"contentUri":{"type":"string","description":"Link to a call recording binary content"},"contentType":{"type":"string","description":"Call recording file format. Supported format is audio/x-wav"},"duration":{"type":"integer","description":"Recorded call duration"}}}}}}},"x-api-group":"account/recording","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallRecording","x-user-permission":"ReadCallRecording","x-feature":"ReadAccountCallRecordings","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/401452676008/recording/401786818008\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"401786818008\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/401452676008/recording/401786818008/content\",\n \"contentType\" : \"audio/x-wav\",\n \"duration\" : 30 \n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [callRecordingId] is not found"}]}},"/restapi/v1.0/account/{accountId}/recording/{recordingId}/content":{"get":{"tags":["Call Recordings"],"summary":"Get Call Recordings Data","description":"Returns media content of a call recording.","operationId":"listCallRecordingData","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"recordingId","in":"path","description":"Internal identifier of a recording (returned in Call Log)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Call Recording Media Data","content":{"audio/x-wav":{"schema":{"type":"string","format":"binary"}},"audio/mpeg":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"account/recording/content","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadCallRecording","x-user-permission":"ReadCallRecording","x-feature":"ReadAccountCallRecordings","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/10979280004/recording/59497406004/content\n","response":"HTTP 200 OK\n[binary data]\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [callRecordingId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/sms":{"post":{"tags":["SMS"],"summary":"Send SMS","description":"Creates and sends a new text message. You can send SMS messages simultaneously to different recipients up to 40 requests per minute; this limitation is relevant for all client applications. Sending and receiving SMS is available for Toll-Free Numbers within the USA. You can send up to 10 attachments in one MMS message; the size of all attachments linked is limited to 1500000 bytes.","operationId":"createSMSMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["from","text","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}}}}},"multipart/mixed":{"schema":{"required":["from","text","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}}}}},"multipart/form-data":{"schema":{"required":["from","text","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}}}}}},"required":true},"responses":{"200":{"description":"Message information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation that the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}}}}}},"x-api-group":"extension/sms","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"Messaging","x-app-permission":"SMS","x-user-permission":"OutboundSMS","x-feature":"SMSSending","x-docs-level":"Public","x-availability":"High","x-codegen-request-body-name":"body","x-http-examples":[{"title":"Send SMS","request":"POST /restapi/v1.0/account/~/extension/~/sms\n\n{\n\"to\": [{\"phoneNumber\": \"+18551003738\"}],\n\"from\": {\"phoneNumber\": \"+18559100010}\"},\n\"text\": \"Test SMS message from Platform server\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/account/1346632010/extension/1346632010/message-store/315450330010\",\n \"id\" : 315450330010,\n \"to\" : [ {\n \"phoneNumber\" : \"+18551003738\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18559100010\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2012-09-13T15:21:08.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 1,\n \"uri\" : \"https://platform.ringcentral.com/account/1346632010/extension/1346632010/message-store/315450330010/content/1\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"conversationId\" : 4481650717038104652,\n \"lastModifiedTime\" : \"2012-09-13T15:21:09.000Z\"\n}\n"},{"title":"Send MMS","request":"POST /restapi/v1.0/account/403391985008/extension/403391985008/sms\nContent-Type: multipart/mixed; boundary=Boundary_1_14413901_1361871080888\n\n--Boundary_1_14413901_1361871080888\nContent-Type: application/json; charset=UTF-8\nContent-Transfer-Encoding: 8bit\n\n{\"to\" :[{\"phoneNumber\": \"+18772004569\"},{\"phoneNumber\": \"+18772094569\"}],\n\"text\" :\"hello\",\n\"from\" :{\"phoneNumber\": \"+18882004237\"}}\n\n--Boundary_1_14413901_1361871080888\nContent-Type: image/png\nContent-Disposition: attachment; filename=\"filename.png\"\n\nHello, World!\n\n--Boundary_1_14413901_1361871080888--\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008\",\n \"id\" : 403038404008,\n \"to\" : [ {\n \"phoneNumber\" : \"+18772004569\"\n }, {\n \"phoneNumber\" : \"+18772094569\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18882004237\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2017-04-14T13:46:54.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 403038404008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008/content/403038404008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n }, {\n \"id\" : 400938873008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008/content/400938873008\",\n \"type\" : \"MmsAttachment\",\n \"contentType\" : \"image/png\",\n \"size\" : 13,\n \"fileName\" : \"filename.png\",\n \"width\": 640,\n \"height\": 480\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"hello\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 4671355828682655051,\n \"lastModifiedTime\" : \"2017-04-14T13:46:54.838Z\"\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [to] value is invalid."},{"httpCode":"400","errorCode":"MSG-243","message":"Parameter [to] value [19044910270] is invalid [Phone number is blocked]"},{"httpCode":"400","errorCode":"MSG-245","message":"Parameter [from] value [88121002330] is invalid [Cannot find the phone number which belongs to user]"},{"httpCode":"400","errorCode":"MSG-246","message":"Sending SMS from/to extension numbers is not available"},{"httpCode":"400","errorCode":"MSG-247","message":"Sending SMS to short numbers is not available"},{"httpCode":"400","errorCode":"MSG-365","message":"Parameters [country.id] and [country.isoCode] can not be specified simultaneously"},{"httpCode":"400","errorCode":"MSG-381","message":"Exceeded maximum number of recipients for a Group MMS: [10]"},{"httpCode":"403","errorCode":"BIL-103","message":"Feature [MMS] is not available for current account"},{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [OutboundSMS] permission."},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [OutboundSMS] permission granted with extended scope"},{"httpCode":"403","errorCode":"MSG-240","message":"International SMS is not available for account."},{"httpCode":"403","errorCode":"MSG-241","message":"Cannot send SMS from Fax number"},{"httpCode":"403","errorCode":"MSG-242","message":"The requested feature is not available"},{"httpCode":"403","errorCode":"MSG-314","message":"Extension is of inappropriate type"},{"httpCode":"403","errorCode":"MSG-367","message":",from phone number does not support SMS"},{"httpCode":"403","errorCode":"MSG-380","message":"The MMS feature is not available"},{"httpCode":"403","errorCode":"MSG-384","message":"Account limits exceeded. Cannot send the message."},{"httpCode":"403","errorCode":"MSG-397","message":"Toll Free SMS is not available for the account"},{"httpCode":"403","errorCode":"MSG-403","message":"International SMS is not allowed from Toll Free phone number"},{"httpCode":"429","errorCode":"MSG-305","message":"Request rate exceeded"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/mms":{"post":{"tags":["SMS"],"summary":"Send MMS","description":"Creates and sends media messages. Sending MMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications.","operationId":"createMMS","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"MMS envelope and content","content":{"application/json":{"schema":{"required":["attachments","from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}},"attachments":{"type":"array","description":"Media file(s) to upload","items":{"type":"string","format":"binary"}}}}},"multipart/mixed":{"schema":{"required":["attachments","from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}},"attachments":{"type":"array","description":"Media file(s) to upload","items":{"type":"string","format":"binary"}}}}},"multipart/form-data":{"schema":{"required":["attachments","from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"},"to":{"type":"array","description":"Message receiver(s) information. The `phoneNumber` value is required","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Message sender information. The `phoneNumber` value should be one the account phone numbers allowed to send the current type of messages"}},"text":{"type":"string","description":"Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"name":{"type":"string","description":"Official name of a country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}}},"attachments":{"type":"array","description":"Media file(s) to upload","items":{"type":"string","format":"binary"}}}}}},"required":true},"responses":{"default":{"description":"MMS Message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation that the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}}}}}},"x-api-group":"extension/sms","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"Messaging","x-app-permission":"SMS","x-user-permission":"OutboundSMS","x-feature":"SMSSending","x-docs-level":"Public","x-availability":"High","x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager":{"post":{"tags":["Pager Messages"],"summary":"Create Internal Text Message","description":"Creates and sends an internal text message.","operationId":"createInternalTextMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["text"],"type":"object","properties":{"from":{"type":"object","properties":{"extensionId":{"type":"string","description":"Extension identifier","example":"123456789"},"extensionNumber":{"type":"string","description":"Extension number","example":"105"}},"description":"Sender of a pager message."},"replyOn":{"type":"integer","description":"Internal identifier of a message this message replies to"},"text":{"type":"string","description":"Text of a pager message. Max length is 1024 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 512 symbols","example":"hello world"},"to":{"type":"array","description":"Optional if replyOn parameter is specified. Receiver of a pager message.","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Extension identifier","example":"123456789"},"extensionNumber":{"type":"string","description":"Extension number","example":"105"}},"description":"Sender of a pager message."}}}}}},"required":true},"responses":{"200":{"description":"Created Text Message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation that the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}}}}}},"x-api-group":"extension/company-pager","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"Messaging","x-app-permission":"InternalMessages","x-user-permission":"InternalSMS","x-feature":"PagesSending","x-docs-level":"Public","x-availability":"High","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/2759647004/extension/2759647004/company-pager\n\n{\n \"to\": [{\"extensionId\": \"2759654004\"}, {\"extensionNumber\": \"104\"}],\n \"from\": {\"extensionId\": \"2759647004\"},\n \"text\": \"Hello!\"\n }\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/2759647004/extension/2759647004/message-store/2640223004\",\n \"id\" : 2640223004,\n \"to\" : [ {\n \"extensionNumber\" : \"105\",\n \"extensionId\" : \"2759654004\",\n \"name\" : \"John Black\"\n }, {\n \"extensionNumber\" : \"104\",\n \"extensionId\" : \"2759653004\",\n \"name\" : \"Jane White\"\n }, {\n \"extensionNumber\" : \"101\",\n \"extensionId\" : \"2759647004\",\n \"name\" : \"Lily Bloomfield\"\n } ],\n \"from\" : {\n \"extensionNumber\" : \"101\",\n \"extensionId\" : \"2759647004\",\n \"name\" : \"Lily Bloomfield\"\n },\n \"type\" : \"Pager\",\n \"creationTime\" : \"2016-09-07T12:37:28.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 2640223004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/2759647004/extension/2759647004/message-store/2640223004/content/2640223004\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Hello!\",\n \"messageStatus\" : \"Sent\",\n \"conversationId\" : 2640223004,\n \"lastModifiedTime\" : \"2016-09-07T12:37:28.520Z\",\n \"pgToDepartment\" : false\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [to.phoneNumber] value is invalid."},{"httpCode":"400","errorCode":"CMN-102","message":"Resource for parameter [from.extensionId] is not found"},{"httpCode":"400","errorCode":"MSG-316","message":"Parameter [to] value [102] is invalid [Target extension not found]"},{"httpCode":"400","errorCode":"MSG-324","message":"Extension is of unappropriate state"},{"httpCode":"400","errorCode":"MSG-331","message":"Parameter [from] value [11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111] is invalid [Sender extension number does not correspond to logged in extension]"},{"httpCode":"400","errorCode":"MSG-332","message":"Parameter [from] value [403989370020] is invalid [Sender extension id does not correspond to logged in extension]"},{"httpCode":"400","errorCode":"MSG-335","message":"Recipient extension number does not correspond to ID"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [InternalMessages] permission"},{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [InternalSMS] permission."},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [InternalSMS] permission granted with extended scope"},{"httpCode":"403","errorCode":"MSG-325","message":"Reply is forbidden for old message threads"},{"httpCode":"403","errorCode":"MSG-326","message":"Reply is denied for user, who is no longer a thread participant"},{"httpCode":"403","errorCode":"MSG-330","message":"Sender extension is of unappropriate type"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [extensionId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax":{"post":{"tags":["Fax"],"summary":"Create Fax Message","description":"Creates and sends/resends a fax message. Resend can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb.","operationId":"createFaxMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account (integer) or tilde (~) to indicate the account which was logged-in within the current session.","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension (integer) or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["attachment","to"],"properties":{"attachment":{"type":"string","description":"File to upload","format":"binary"},"faxResolution":{"type":"string","description":"Resolution of Fax","enum":["High","Low"]},"to":{"type":"array","description":"To Phone Number","items":{"type":"string"}},"sendTime":{"type":"string","description":"Timestamp to send fax at. If not specified (current or the past), the fax is sent immediately","format":"date-time"},"isoCode":{"type":"string","description":"ISO Code. e.g UK"},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages. If not specified, the default cover page which is configured in 'Outbound Fax Settings' is attached","format":"int32"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}}},"required":true},"responses":{"200":{"description":"Fax Message","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message","format":"int64"},"uri":{"type":"string","description":"Canonical URI of a message"},"type":{"type":"string","description":"Message type - 'Fax'"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"}},"description":"Sender information"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"name":{"type":"string"},"location":{"type":"string"},"messageStatus":{"type":"string","enum":["Sent","SendingFailed","Queued"]},"faxErrorCode":{"type":"string","enum":["Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]}}}},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment","format":"int64"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Voicemail only Duration of the voicemail in seconds"},"filename":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"}}}},"direction":{"type":"string","description":"Message direction","enum":["Inbound","Outbound"]},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"messageStatus":{"type":"string","description":"Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default)","enum":["Queued","Sent","SendingFailed","Received"]},"faxResolution":{"type":"string","description":"Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)","enum":["High","Low"]},"faxPageCount":{"type":"integer","description":"Page count in a fax message"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}}}}},"x-api-group":"extension/fax","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"Faxes","x-user-permission":"OutboundFaxes","x-feature":"FaxSending","x-docs-level":"Public","x-team":"PLA Inno","x-availability":"High","x-http-examples":[{"title":"Multipart/Form-data","request":"POST /restapi/v1.0/account/691748004/extension/691748004/fax\nContent-Type: multipart/form-data; boundary=Boundary_14_2952358_1361963763144\n\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"coverPageText\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\n\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"coverIndex\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\n2\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"faxResolution\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\nHigh\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"sendTime\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\n2030-03-19T08:00:00.000Z\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"isoCode\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\nGB\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"to\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\n+18774880001\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"to\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\n+18004778345\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"attachment\"\nContent-Transfer-Encoding: binary\nContent-Type: text/plain\n\nattachment1\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"attachment\"; filename=\"1\"\nContent-Transfer-Encoding: binary\nContent-Type: text/plain\n\nattachment2\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"attachment\"; filename=\"2\"\nContent-Transfer-Encoding: binary\nContent-Type: text/plain\n\nattachment3\n--Boundary_14_2952358_1361963763144--\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/691748004/extension/691748004/message-store/1277646004\",\n \"id\" : 1277646004,\n \"to\" : [ {\n \"phoneNumber\" : \"+18774880001\",\n \"messageStatus\" : \"Queued\"\n }, {\n \"phoneNumber\" : \"+18004778345\",\n \"messageStatus\" : \"Queued\"\n } ],\n \"type\" : \"Fax\",\n \"creationTime\" : \"2016-06-14T13:38:06.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 1277646004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/691748004/extension/691748004/message-store/1277646004/content/1277646004\",\n \"type\" : \"RenderedDocument\",\n \"contentType\" : \"application/pdf\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Queued\",\n \"faxResolution\" : \"High\",\n \"faxPageCount\" : 0,\n \"lastModifiedTime\" : \"2016-06-14T13:38:06.040Z\",\n \"coverIndex\" : 2\n \n}\n"},{"title":"Multipart/Mixed","request":"POST /restapi/v1.0/account/1446856004/extension/1446856004/fax\nContent-Type: multipart/mixed; boundary=Boundary_1_14413901_1361871080888\n\n--Boundary_1_14413901_1361871080888\nContent-Type: application/json\n\n{\"to\":[{\"phoneNumber\":\"+18005630003\", \"name\": \"John Smith\"}],\n \"faxResolution\":\"High\",\n \"country\" : {\n \"isoCode\" : \"IE\"\n },\n \"sendTime\":\"2013-02-26T09:31:20.882Z\"}\n\n--Boundary_1_14413901_1361871080888\nContent-Disposition: attachment; filename=\"fax.txt\"\n\nHello, World!\n\n--Boundary_1_14413901_1361871080888--\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/2704667004/extension/2704667004/message-store/3349579004\",\n \"id\" : 3349579004,\n \"to\" : [ {\n \"phoneNumber\" : \"+18005630003\",\n \"name\" : \"John Smith\",\n \"messageStatus\" : \"Queued\"\n } ],\n \"type\" : \"Fax\",\n \"creationTime\" : \"2015-12-10T10:14:28.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 3349579004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/2704667004/extension/2704667004/message-store/3349579004/content/3349579004\",\n \"type\" : \"RenderedDocument\",\n \"contentType\" : \"application/pdf\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Queued\",\n \"faxResolution\" : \"High\",\n \"faxPageCount\" : 0,\n \"lastModifiedTime\" : \"2015-12-10T10:14:28.836Z\",\n \"coverIndex\" : 7\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [OutboundFaxes] permission granted with extended scope"}]}},"/restapi/v1.0/dictionary/fax-cover-page":{"get":{"tags":["Fax"],"summary":"Get Fax Cover Page List","description":"Returns fax cover pages available for the current extension.","operationId":"listFaxCoverPages","parameters":[{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"List of Fax Cover Pages","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a fax cover page. The possible value range is 0-13 (for language setting en-US) and 0, 15-28 (for all other languages)"},"name":{"type":"string","description":"Name of a fax cover page pattern"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/fax-cover-page","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-team":"PLA Inno","x-http-examples":[{"title":"Language Setting - US","request":"GET /restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=10\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\",\n \"records\" : [ {\n \"id\" : \"0\",\n \"name\" : \"None\"\n }, {\n \"id\" : \"1\",\n \"name\" : \"Ancient\"\n }, {\n \"id\" : \"2\",\n \"name\" : \"Birthday\"\n }, {\n \"id\" : \"3\",\n \"name\" : \"Blank\"\n }, {\n \"id\" : \"4\",\n \"name\" : \"Clasmod\"\n }, {\n \"id\" : \"5\",\n \"name\" : \"Classic\"\n }, {\n \"id\" : \"6\",\n \"name\" : \"Confidential\"\n }, {\n \"id\" : \"7\",\n \"name\" : \"Contempo\"\n }, {\n \"id\" : \"8\",\n \"name\" : \"Elegant\"\n }, {\n \"id\" : \"9\",\n \"name\" : \"Express\"\n }, {\n \"id\" : \"10\",\n \"name\" : \"Formal\"\n }, {\n \"id\" : \"11\",\n \"name\" : \"Jazzy\"\n }, {\n \"id\" : \"12\",\n \"name\" : \"Modern\"\n }, {\n \"id\" : \"13\",\n \"name\" : \"Urgent\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 14,\n \"pageStart\" : 0,\n \"pageEnd\" : 13\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\"\n }\n }\n}\n"},{"title":"Language Settings - not US","request":"GET /restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=10\n","response":"HTTP 200 OK\n\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\",\n \"records\" : [ {\n \"id\" : \"0\",\n \"name\" : \"None\"\n }, {\n \"id\" : \"15\",\n \"name\" : \"English (United States)\"\n }, {\n \"id\" : \"16\",\n \"name\" : \"French (Canada)\"\n }, {\n \"id\" : \"17\",\n \"name\" : \"English (United Kingdom)\"\n }, {\n \"id\" : \"18\",\n \"name\" : \"French\"\n }, {\n \"id\" : \"19\",\n \"name\" : \"German\"\n }, {\n \"id\" : \"20\",\n \"name\" : \"Italian\"\n }, {\n \"id\" : \"21\",\n \"name\" : \"Spanish\"\n }, {\n \"id\" : \"22\",\n \"name\" : \"Spanish (Latin America)\"\n }, {\n \"id\" : \"23\",\n \"name\" : \"Japanese\"\n }, {\n \"id\" : \"24\",\n \"name\" : \"Portuguese (Brazil)\"\n }, {\n \"id\" : \"26\",\n \"name\" : \"Chinese (Simplified)\"\n }, {\n \"id\" : \"27\",\n \"name\" : \"Chinese (Traditional)\"\n }, {\n \"id\" : \"28\",\n \"name\" : \"Chinese (HongKong)\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 14,\n \"pageStart\" : 0,\n \"pageEnd\" : 13\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100\"\n }\n }\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [page] value is invalid."},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store":{"get":{"tags":["Message Store"],"summary":"Get Message List","description":"Returns the list of messages from an extension mailbox.","operationId":"listMessages","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"availability","in":"query","description":"Specifies the availability status for the resulting messages. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Alive","Deleted","Purged"]}}},{"name":"conversationId","in":"query","description":"Specifies the conversation identifier for the resulting messages","schema":{"type":"integer"}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours","schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time","schema":{"type":"string","format":"date-time"}},{"name":"direction","in":"query","description":"The direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"distinctConversations","in":"query","description":"If 'True', then the latest messages per every conversation ID are returned","schema":{"type":"boolean"}},{"name":"messageType","in":"query","description":"The type of the resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}},{"name":"readStatus","in":"query","description":"The read status for the resulting messages. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Read","Unread"]}}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"phoneNumber","in":"query","description":"The phone number. If specified, messages are returned for this particular phone number only","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of user messages"},"records":{"type":"array","description":"List of records with message information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/message-store","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadMessages","x-user-permission":"ReadMessages","x-feature":"ReadMessages","x-docs-level":"Public","x-availability":"High","x-notifications":[{"type":"object","properties":{"aps":{"type":"object","properties":{"alert":{"type":"object","properties":{"title":{"type":"string","description":"Title of a message"},"body":{"type":"string","description":"Message Description"}},"description":"Alert information"},"badge":{"type":"string","description":"Number of incoming messages"},"sound":{"type":"string","description":"Message sound"},"content-available":{"type":"string","description":"Content availability"},"category":{"type":"string","description":"Category of a message"}},"description":"Information on a notification"},"messageId":{"type":"string","description":"Internal identifier of a message"},"conversationId":{"type":"string","description":"Internal identifier of a conversation"},"from":{"type":"string","description":"Sender phone number. For GCM transport type '_from' property should be used"},"to":{"type":"string","description":"Receiver phone number"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}},{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message. The default value is 'SMS'"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound"},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Deprecated. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"lastUpdated":{"type":"string","description":"Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"changes":{"type":"array","description":"Message Changes","items":{"type":"object","properties":{"type":{"type":"string","description":"Message type","enum":["Voicemail","SMS","Fax","Pager"]},"newCount":{"type":"integer","description":"The number of new messages. Can be omitted if the value is zero"},"updatedCount":{"type":"integer","description":"The number of updated messages. Can be omitted if the value is zero"}}}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-http-examples":[{"request":"GET /restapi/v1.0/account/401928394008/extension/401928394008/message-store?direction=Inbound&readStatus=Unread&perPage=2\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store?direction=Inbound&readStatus=Unread&availability=Alive&dateFrom=2018-09-17T12:53:00.000Z&page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406986008\",\n \"id\" : 402406986008,\n \"to\" : [ {\n \"name\" : \"Jane Smith\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18888984591\",\n \"name\" : \"RingCentral\"\n },\n \"type\" : \"VoiceMail\",\n \"creationTime\" : \"2018-09-18T09:24:04.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 402406986008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406986008/content/402406986008\",\n \"type\" : \"AudioRecording\",\n \"contentType\" : \"audio/x-wav\",\n \"vmDuration\" : 42\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Welcome to RingCentral!\",\n \"messageStatus\" : \"Received\",\n \"lastModifiedTime\" : \"2018-09-18T09:24:04.102Z\",\n \"vmTranscriptionStatus\" : \"NotAvailable\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406984008\",\n \"id\" : 402406984008,\n \"to\" : [ {\n \"name\" : \"Jane Smith\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18442058517\",\n \"name\" : \"RingCentral\"\n },\n \"type\" : \"VoiceMail\",\n \"creationTime\" : \"2018-09-18T09:24:03.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 402406984008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406984008/content/402406984008\",\n \"type\" : \"AudioRecording\",\n \"contentType\" : \"audio/x-wav\",\n \"vmDuration\" : 25\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Received\",\n \"lastModifiedTime\" : \"2018-09-18T09:24:03.531Z\",\n \"vmTranscriptionStatus\" : \"NotAvailable\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 2,\n \"totalElements\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store?direction=Inbound&readStatus=Unread&availability=Alive&dateFrom=2018-09-17T12:53:00.000Z&page=1&perPage=2\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store?direction=Inbound&readStatus=Unread&availability=Alive&dateFrom=2018-09-17T12:53:00.000Z&page=1&perPage=2\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [direction] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadMessages] permission granted with extended scope"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [extensionId] is not found"}]},"delete":{"tags":["Message Store"],"summary":"Delete Conversation","description":"Deletes conversation(s) by conversation ID(s). Batch request is supported, max number of IDs passed as query/path parameters is 50. Alternative syntax is supported - user converations can be deleted by passing multiple IDs in request body as an array of string, max number of conversation IDs passed in request body is 100. In this case asterisk is used in the path instead of IDs","operationId":"deleteMessageByFilter","parameters":[{"name":"conversationId","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"dateTo","in":"query","description":"Messages received earlier then the date specified will be deleted. The default value is current datetime","schema":{"type":"string","format":"date-time"}},{"name":"type","in":"query","description":"Type of messages to be deleted","schema":{"type":"string","default":"All","enum":["Fax","SMS","VoiceMail","Pager","Text","All"]}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/message-store","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditMessages","x-user-permission":"EditMessages","x-feature":"EditMessages","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/3632358004/extension/3632358004/message-store?conversationId=7118033917873890173&conversationId=3292704822660695422\n","response":"HTTP 204 No Content\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"MSG-390","message":"[conversationId] and [type] query parameters cannot be specified simultaneously"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditMessages] permission"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [EditMessages] permission granted with extended scope"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}":{"get":{"tags":["Message Store"],"summary":"Get Message","description":"Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported.","operationId":"readMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"messageId","in":"path","description":"Internal identifier of a message","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of a resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a message"},"id":{"type":"string","description":"Internal identifier of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed"]}}}}}}}}},"x-api-group":"extension/message-store","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadMessages","x-user-permission":"ReadMessages","x-feature":"ReadMessages","x-docs-level":"Public","x-availability":"High","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"},"body":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message"},"to":{"type":"array","description":"Message receiver(s) information","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}}}},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 (with '+' sign) format"},"extensionNumber":{"type":"string","description":"Extension number"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"}},"description":"Extension Type. For GCM transport type '_from' property should be used || Message sender information"},"type":{"type":"string","description":"Type of a message","enum":["Voicemail"]},"creationTime":{"type":"string","description":"Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"lastModifiedTime":{"type":"string","description":"Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2019-03-10T18:07:52.534Z*"},"readStatus":{"type":"string","description":"Status of a message","default":"Unread"},"priority":{"type":"string","description":"Message priority","default":"Normal"},"attachments":{"type":"array","description":"Message attachment data","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"direction":{"type":"string","description":"Message direction","default":"Inbound","enum":["Inbound","Outbound"]},"availability":{"type":"string","description":"Message availability status","default":"Alive"},"subject":{"type":"string","description":"Message subject. It replicates message text which is also returned as an attachment"},"messageStatus":{"type":"string","description":"Status of a message","default":"Received"},"conversationId":{"type":"string","description":"Internal identifier of a conversation this message belongs to"},"vmTranscriptionStatus":{"type":"string","description":"Specifies if a voicemail message transcription is already completed or not"}},"description":"Notification payload body"}}}],"x-http-examples":[{"title":"Voicemail","request":"GET /restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406984008\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406984008\",\n \"id\" : 402406984008,\n \"to\" : [ {\n \"name\" : \"John Smith\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18442058517\",\n \"name\" : \"RingCentral\"\n },\n \"type\" : \"VoiceMail\",\n \"creationTime\" : \"2018-09-18T09:24:03.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 402406984008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401928394008/extension/401928394008/message-store/402406984008/content/402406984008\",\n \"type\" : \"AudioRecording\",\n \"contentType\" : \"audio/x-wav\",\n \"vmDuration\" : 25\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Received\",\n \"lastModifiedTime\" : \"2018-09-18T09:24:03.531Z\",\n \"vmTranscriptionStatus\" : \"NotAvailable\" \n}\n"},{"title":"Internal Message","request":"GET /restapi/v1.0/account/400928048004/extension/400928050004/message-store/401081345004\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400928048004/extension/400928050004/message-store/401081345004\",\n \"id\" : 401081345004,\n \"to\" : [ {\n \"extensionNumber\" : \"103\"\n \n } ],\n \"from\" : {\n \"extensionNumber\" : \"102\",\n \"name\" : \"John Smith\"\n },\n \"type\" : \"Pager\",\n \"creationTime\" : \"2014-09-01T19:26:45.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401081345004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400928048004/extension/400928050004/message-store/401081345004/content/401081345004\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Sample message\",\n \"messageStatus\" : \"Sent\",\n \"conversationId\" : 6951365551500,\n \"lastModifiedTime\" : \"2014-09-01T12:26:44.114Z\",\n \"pgToDepartment\" : false \n}\n"},{"title":"SMS","request":"GET /restapi/v1.0/account/12502999004/extension/12502999004/message-store/60279564004\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/12502999004/extension/12502999004/message-store/60279564004\",\n \"id\" : 60279564004,\n \"to\" : [ {\n \"phoneNumber\" : \"+16505393204\",\n \"location\" : \"San Mateo, CA\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18889450052\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-02-18T13:24:50.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 60279564004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/12502999004/extension/12502999004/message-store/60279564004/content/60279564004\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Flight information\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 5578984350117917661,\n \"lastModifiedTime\" : \"2015-02-18T13:24:50.300Z\"\n}\n"},{"title":"MMS","request":"GET /restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008\",\n \"id\" : 403038404008,\n \"to\" : [ {\n \"phoneNumber\" : \"+18772004569\"\n }, {\n \"phoneNumber\" : \"+18772094569\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18882004237\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2017-04-14T13:46:54.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 403038404008,\n \"uri\" : \"https://media.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008/content/403038404008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n }, {\n \"id\" : 400938873008,\n \"uri\" : \"https://media.ringcentral.com/restapi/v1.0/account/403391985008/extension/403391985008/message-store/403038404008/content/400938873008\",\n \"type\" : \"MmsAttachment\",\n \"contentType\" : \"image/png\",\n \"size\" : 13,\n \"fileName\" : \"filename.png\",\n \"width\": 640,\n \"height\": 480\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Flight information\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 4671355828682655051,\n \"lastModifiedTime\" : \"2017-04-14T13:46:54.838Z\"\n}\n"},{"title":"Fax","request":"GET https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009,5209304004\n\n","response":"HTTP 207\n\n--Boundary_26_60046980_1537367834367\nContent-Type: application/json\n\n{\n \"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338222009\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n } ]\n}\n--Boundary_26_60046980_1537367834367\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009\",\n \"id\" : 6338256009,\n \"to\" : [ {\n \"phoneNumber\" : \"+18882032391\",\n \"messageStatus\" : \"Sent\"\n } ],\n \"type\" : \"Fax\",\n \"creationTime\" : \"2018-09-19T14:36:25.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 6338256009,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009/content/6338256009\",\n \"type\" : \"RenderedDocument\",\n \"contentType\" : \"application/pdf\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Sent\",\n \"faxResolution\" : \"High\",\n \"faxPageCount\" : 0,\n \"lastModifiedTime\" : \"2018-09-19T14:36:25.990Z\",\n \"coverIndex\" : 22\n}\n--Boundary_26_60046980_1537367834367\nContent-Type: application/json\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/5209304004\",\n \"id\": 5209304004,\n \"from\": {\n \"phoneNumber\": \"+18885287464\"\n },\n \"type\": \"Fax\",\n \"creationTime\": \"2018-10-08T09:17:27.000Z\",\n \"readStatus\": \"Unread\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 5209304004,\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/5209304004/content/5209304004\",\n \"type\": \"RenderedDocument\",\n \"contentType\": \"application/pdf\"\n }\n ],\n \"direction\": \"Inbound\",\n \"availability\": \"Alive\",\n \"subject\": \"+15876009976\",\n \"messageStatus\": \"Received\",\n \"faxResolution\": \"High\",\n \"faxPageCount\": 1,\n \"lastModifiedTime\": \"2018-10-08T09:17:27.227Z\"\n}\n--Boundary_26_60046980_1537367834367--\n"},{"title":"Multiple Messages","request":"GET restapi/v1.0/account/306059004/extension/306061004/message-store/972869004,111\nAccept=application/vnd.ringcentral.multipart+json\n\n","response":"HTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972869004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306059004/extension/306061004/message-store/972869004\",\n \"id\": 972869004,\n \"to\": [\n {\n \"phoneNumber\": \"+17607822229\",\n \"location\": \"Warner Springs, CA\"\n }\n ],\n \"from\": {\n \"phoneNumber\": \"+15013030165\",\n \"name\": \"Generated sms message\",\n \"location\": \"Benton, AR\"\n },\n \"type\": \"SMS\",\n \"creationTime\": \"2018-12-24T07:39:12.000Z\",\n \"readStatus\": \"Unread\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972869004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306059004/extension/306061004/message-store/972869004/content/972869004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"SMS: direction=Inbox delivery=DELIVERED unread=true\",\n \"messageStatus\": \"Queued\",\n \"conversationId\": 8234962969801172000,\n \"conversation\": {\n \"id\": \"8234962969801171948\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/8234962969801171948\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:11.666Z\"\n }\n },\n {\n \"resourceId\": \"111\",\n \"status\": 404,\n \"body\": {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"parameterName\": \"messageId\"\n }\n ],\n \"parameterName\": \"messageId\"\n }\n }\n]\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadMessages] permission granted with extended scope"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [messageId] is not found"}]},"put":{"tags":["Message Store"],"summary":"Update Message List","description":"Updates message(s) by ID(s). Currently only message read status can be updated. Batch request is supported, max number of IDs passed as query/path parameters is 50. Alternative syntax is supported - user messages can be updated by passing multiple IDs in request body as an array of string, max number of IDs passed in request body is 1000. In this case asterisk is used in the path instead of IDs.","operationId":"updateMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"messageId","in":"path","description":"Internal identifier of a message","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"dateFrom","in":"query","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","enum":["Fax","SMS","VoiceMail","Pager","Text","All"]}}],"requestBody":{"description":"JSON body","content":{"multipart/mixed":{"schema":{"type":"object","properties":{"readStatus":{"type":"string","description":"Read status of a message to be changed. Multiple values are accepted","enum":["Read","Unread"]}}}},"application/json":{"schema":{"type":"object","properties":{"readStatus":{"type":"string","description":"Read status of a message to be changed. Multiple values are accepted","enum":["Read","Unread"]}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of a resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a message"},"id":{"type":"string","description":"Internal identifier of a message"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string"},"extensionId":{"type":"string"},"name":{"type":"string"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed"]}}}}}}}}},"x-api-group":"extension/message-store","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditMessages","x-user-permission":"EditMessages","x-feature":"EditMessages","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"Single Message","request":"PUT /restapi/v1.0/account/401934951008/extension/401934951008/message-store/402412194008\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401934951008/extension/401934951008/message-store/402412194008\",\n \"id\" : 402412194008,\n \"to\" : [ {\n \"name\" : \"John Smith\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18888984591\",\n \"name\" : \"RingCentral\"\n },\n \"type\" : \"VoiceMail\",\n \"creationTime\" : \"2018-09-18T16:11:04.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 402412194008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401934951008/extension/401934951008/message-store/402412194008/content/402412194008\",\n \"type\" : \"AudioRecording\",\n \"contentType\" : \"audio/x-wav\",\n \"vmDuration\" : 42\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Welcome to RingCentral!\",\n \"messageStatus\" : \"Received\",\n \"lastModifiedTime\" : \"2018-09-18T16:22:54.951Z\",\n \"vmTranscriptionStatus\" : \"Unknown\"\n}\n"},{"title":"Multiple Messages #1","request":"PUT /restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338222009,6338256009\nContent-Type: multipart/mixed; boundary=Boundary_28_61155598_1537368499123\n\n--Boundary_28_61155598_1537368499123\nContent-Type: application/json\n\n{\"readStatus\": \"Read\"}\n--Boundary_28_61155598_1537368499123\nContent-Type: application/json\n\n{\"readStatus\": \"Read\"}\n--Boundary_28_61155598_1537368499123\n","response":"HTTP 207 \nContent-Type: multipart/mixed;boundary=Boundary_28_61155598_1537368499123\n\n--Boundary_28_61155598_1537368499123\nContent-Type: application/json\n\n{\n \"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338222009\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n } ]\n}\n--Boundary_28_61155598_1537368499123\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338222009\",\n \"id\" : 6338222009,\n \"to\" : [ {\n \"phoneNumber\" : \"+18882032391\",\n \"messageStatus\" : \"Sent\"\n } ],\n \"type\" : \"Fax\",\n \"creationTime\" : \"2018-09-19T14:36:19.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 6338222009,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338222009/content/6338222009\",\n \"type\" : \"RenderedDocument\",\n \"contentType\" : \"application/pdf\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Sent\",\n \"faxResolution\" : \"High\",\n \"faxPageCount\" : 2,\n \"lastModifiedTime\" : \"2018-09-19T14:48:19.107Z\",\n \"coverIndex\" : 22\n}\n--Boundary_28_61155598_1537368499123\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009\",\n \"id\" : 6338256009,\n \"to\" : [ {\n \"phoneNumber\" : \"+18882032391\",\n \"messageStatus\" : \"Sent\"\n } ],\n \"type\" : \"Fax\",\n \"creationTime\" : \"2018-09-19T14:36:25.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 6338256009,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338256009/content/6338256009\",\n \"type\" : \"RenderedDocument\",\n \"contentType\" : \"application/pdf\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Sent\",\n \"faxResolution\" : \"High\",\n \"faxPageCount\" : 2,\n \"lastModifiedTime\" : \"2018-09-19T14:48:19.115Z\",\n \"coverIndex\" : 22\n}\n--Boundary_28_61155598_1537368499123--\n"},{"title":"Multiple Messages #2","request":"PUT /restapi/v1.0/account/306065004/extension/306067004/message-store/972903004,972901004\nContent-Type=application/vnd.ringcentral.multipart+json\n\n[\n {\n \"body\": {\n \"readStatus\": \"Read\"\n }\n },\n {\n \"body\": {\n \"readStatus\": \"Read\"\n }\n }\n]\n","response":"HTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972903004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004\",\n \"id\": 972903004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"John Smith\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972903004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004/content/972903004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"Message subject\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.873Z\",\n \"pgToDepartment\": false\n }\n },\n {\n \"resourceId\": \"972901004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004\",\n \"id\": 972901004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"John Smith\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972901004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004/content/972901004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"Message subject\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.879Z\",\n \"pgToDepartment\": false\n }\n }\n]\n"},{"title":"Multiple Messages #3","request":"PUT /restapi/v1.0/account/306065004/extension/306067004/message-store/*\nContent-Type=application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972903004\",\n \"body\": {\n \"readStatus\": \"Read\"\n }\n },\n {\n \"resourceId\": \"972901004\",\n \"body\": {\n \"readStatus\": \"Read\"\n }\n }\n]\n","response":"HTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972903004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004\",\n \"id\": 972903004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"John Smith\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972903004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004/content/972903004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"Message subject\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.873Z\",\n \"pgToDepartment\": false\n }\n },\n {\n \"resourceId\": \"972901004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004\",\n \"id\": 972901004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"Generated IM message\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972901004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004/content/972901004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"IM: direction=Outbox unread=true\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.879Z\",\n \"pgToDepartment\": false\n }\n }\n]\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [] value is invalid."},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditMessages] permission"},{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [EditMessages] permission."},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [EditMessages] permission granted with extended scope"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"delete":{"tags":["Message Store"],"summary":"Delete Message","description":"Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to 'True'.","operationId":"deleteMessage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"messageId","in":"path","description":"Internal identifier of a message","required":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"purge","in":"query","description":"If the value is 'True', then the message is purged immediately with all the attachments","schema":{"type":"boolean","default":false}},{"name":"conversationId","in":"query","description":"Internal identifier of a message thread","schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/message-store","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditMessages","x-user-permission":"EditMessages","x-feature":"EditMessages","x-docs-level":"Public","x-http-examples":[{"title":"Single Message","request":"DELETE /restapi/v1.0/account/1346632010/extension/1346632010/message-store/315433012010\n","response":"HTTP 204 No Content\n"},{"title":"Multiple Messages #1","request":"DELETE /restapi/v1.0/account/403057678008/extension/403057678008/message-store/403535598008, 403535596008?purge=false\n","response":"HTTP 204 No Content\n"},{"title":"Multiple Messages #2","request":"DELETE /restapi/v1.0/account/306047004/extension/306047004/message-store/972719004,111\nAccept=application/vnd.ringcentral.multipart+json\n","response":"HTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972719004\",\n \"status\": 204\n },\n {\n \"resourceId\": \"111\",\n \"status\": 404,\n \"body\": {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"parameterName\": \"messageId\"\n }\n ],\n \"parameterName\": \"messageId\"\n }\n }\n]\n"},{"title":"Multiple Messages #3","request":"POST /restapi/v1.0/account/306053004/extension/306053004/message-store/*\nAccept=application/vnd.ringcentral.multipart+json\n[\n \"972719004\",\n \"111\"\n]\n","response":"HTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972719004\",\n \"status\": 204\n },\n {\n \"resourceId\": \"111\",\n \"status\": 404,\n \"body\": {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"parameterName\": \"messageId\"\n }\n ],\n \"parameterName\": \"messageId\"\n }\n }\n]\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [purge] value is invalid."},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [EditMessages] permission granted with extended scope"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}":{"get":{"tags":["Message Store"],"summary":"Get Message Content","description":"Returns a specific message attachment data as media stream.","operationId":"readMessageContent","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"attachmentId","in":"path","description":"Internal identifier of a message attachment","required":true,"schema":{"type":"integer"}},{"name":"messageId","in":"path","description":"Internal identifier of a message","required":true,"schema":{"type":"integer"}},{"name":"Range","in":"header","schema":{"type":"string"}},{"name":"contentDisposition","in":"query","description":"Content disposition of a response","schema":{"type":"string","default":"Inline","enum":["Inline","Attachment"]}}],"responses":{"200":{"description":"Attachment Data","content":{"text/plain":{"schema":{"type":"string","format":"binary"}},"image/tiff":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"extension/message-store/content","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadMessages","x-user-permission":"ReadMessageContent","x-feature":"ReadMessages","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/405076340009/extension/405076340009/message-store/6338247009/content/6338247009\n","response":"HTTP 200 OK\n\n[binary data]\n\n"},{"title":"Content Disposition - Attachment","request":"GET /restapi/v1.0/account/402406708008/extension/402406708008/message-store/403201507008/content/403201507008?contentDisposition=Attachment\n\n","response":"HTTP 200 OK\nContent-Type: audio/x-wav\nContent-Disposition: attachment;filename=403201507008.wav\n\n"},{"title":"Content Disposition - Inline","request":"GET /restapi/v1.0/account/402406708008/extension/402406708008/message-store/403201507008/content/403201507008?contentDisposition=Inline\n\n","response":"HTTP 200 OK\nContent-Type: audio/x-wav\nContent-Disposition: inline;filename=403201507008.wav\n\n[binary content]\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [attachmentId] is not found"},{"httpCode":"416","errorCode":"CMN-107","message":"Requested range not satisfiable"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync":{"get":{"tags":["Message Store"],"summary":"Sync Messages","description":"Synchronizes messages.","operationId":"syncMessages","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"conversationId","in":"query","description":"Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only.","schema":{"type":"integer"}},{"name":"dateFrom","in":"query","description":"The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours","schema":{"type":"string","format":"date-time"}},{"name":"dateTo","in":"query","description":"The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time","schema":{"type":"string","format":"date-time"}},{"name":"direction","in":"query","description":"Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Inbound","Outbound"]}}},{"name":"distinctConversations","in":"query","description":"If 'True', then the latest messages per every conversation ID are returned","schema":{"type":"boolean"}},{"name":"messageType","in":"query","description":"Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Fax","SMS","VoiceMail","Pager","Text"]}}},{"name":"recordCount","in":"query","description":"Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified)","schema":{"type":"integer"}},{"name":"syncToken","in":"query","description":"Value of syncToken property of last sync request response","schema":{"type":"string"}},{"name":"syncType","in":"query","description":"Type of message synchronization","schema":{"type":"string","enum":["FSync","ISync"]}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["records","syncInfo"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the message sync resource"},"records":{"type":"array","description":"List of message records with synchronization information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message"},"uri":{"type":"string","description":"Canonical URI of a message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"attachments":{"type":"array","description":"The list of message attachments","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message attachment"},"uri":{"type":"string","description":"Canonical URI of a message attachment"},"type":{"type":"string","description":"Type of message attachment","enum":["AudioRecording","AudioTranscription","Text","SourceDocument","RenderedDocument","MmsAttachment"]},"contentType":{"type":"string","description":"MIME type for a given attachment, for instance 'audio/wav'"},"vmDuration":{"type":"integer","description":"Supported for `Voicemail` only. Duration of a voicemail in seconds"},"fileName":{"type":"string","description":"Name of a file attached"},"size":{"type":"integer","description":"Size of attachment in bytes"},"height":{"type":"integer","description":"Attachment height in pixels if available"},"width":{"type":"integer","description":"Attachment width in pixels if available"}}}},"availability":{"type":"string","description":"Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly","enum":["Alive","Deleted","Purged"]},"conversationId":{"type":"integer","description":"SMS and Pager only. Identifier of a conversation the message belongs to"},"conversation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"uri":{"type":"string","description":"Deprecated. Link to a conversation resource"}},"description":"SMS and Pager only. Information about a conversation the message belongs to"},"creationTime":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryErrorCode":{"type":"string","description":"SMS only. Delivery error code returned by gateway"},"direction":{"type":"string","description":"Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound","enum":["Inbound","Outbound"]},"faxPageCount":{"type":"integer","description":"Fax only. Page count in a fax message"},"faxResolution":{"type":"string","description":"Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi","enum":["High","Low"]},"from":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}},"description":"Sender information"},"lastModifiedTime":{"type":"string","description":"The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"messageStatus":{"type":"string","description":"Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned: If status for at least one recipient is 'Queued', then 'Queued' value is returned If status for at least one recipient is 'SendingFailed', then 'SendingFailed' value is returned In other cases Sent status is returned","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"pgToDepartment":{"type":"boolean","description":"'Pager' only. 'True' if at least one of the message recipients is 'Department' extension"},"priority":{"type":"string","description":"Message priority","enum":["Normal","High"]},"readStatus":{"type":"string","description":"Message read status","enum":["Read","Unread"]},"smsDeliveryTime":{"type":"string","description":"SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral","format":"date-time"},"smsSendingAttemptsCount":{"type":"integer","description":"SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable)"},"subject":{"type":"string","description":"Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment"},"to":{"type":"array","description":"Recipient information","items":{"type":"object","properties":{"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message"},"extensionId":{"type":"string"},"location":{"type":"string","description":"Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)"},"target":{"type":"boolean","description":"'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers"},"messageStatus":{"type":"string","description":"Status of a message. Returned for outbound fax messages only","enum":["Queued","Sent","Delivered","DeliveryFailed","SendingFailed","Received"]},"faxErrorCode":{"type":"string","description":"Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed'. Supported for fax messages only","enum":["AllLinesInUse","Undefined","NoFaxSendPermission","NoInternationalPermission","NoFaxMachine","NoAnswer","LineBusy","CallerHungUp","NotEnoughCredits","SentPartially","InternationalCallingDisabled","DestinationCountryDisabled","UnknownCountryCode","NotAccepted","InvalidNumber","CallDeclined","TooManyCallsPerLine","CallFailed","RenderingFailed","TooManyPages","ReturnToDBQueue","NoCallTime","WrongNumber","ProhibitedNumber","InternalError","FaxSendingProhibited","ThePhoneIsBlacklisted","UserNotFound","ConvertError","DBGeneralError","SkypeBillingFailed","AccountSuspended","ProhibitedDestination","InternationalDisabled"]},"name":{"type":"string","description":"Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then"},"phoneNumber":{"type":"string","description":"Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS"}}}},"type":{"type":"string","description":"Message type","enum":["Fax","SMS","VoiceMail","Pager","Text"]},"vmTranscriptionStatus":{"type":"string","description":"Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned","enum":["NotAvailable","InProgress","TimedOut","Completed","CompletedPartially","Failed","Unknown"]},"coverIndex":{"type":"integer","description":"Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method"},"coverPageText":{"type":"string","description":"Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","description":"Type of synchronization","enum":["FSync","ISync"]},"syncToken":{"type":"string","description":"Synchronization token"},"syncTime":{"type":"string","description":"Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}},"description":"Sync type, token and time"}}}}}}},"x-api-group":"extension/message-sync","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadMessages","x-user-permission":"ReadMessages","x-feature":"ReadMessages","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Full Sync","request":"GET /restapi/v1.0/account/400371259008/extension/400371259008/message-sync?syncType=FSync&recordCount=2&distinctConversations=true\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-sync?syncType=FSync&recordCount=2&distinctConversations=true\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060286008\",\n \"id\" : 401060286008,\n \"to\" : [ {\n \"phoneNumber\" : \"+16508783254\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:14:37.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060286008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060286008/content/401060286008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 1817157275107994090,\n \"lastModifiedTime\" : \"2015-11-18T14:14:38.166Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060274008\",\n \"id\" : 401060274008,\n \"to\" : [ {\n \"phoneNumber\" : \"+16508783204\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:14:26.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060274008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060274008/content/401060274008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 2701081737197845093,\n \"lastModifiedTime\" : \"2015-11-18T14:14:26.434Z\"\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"FSync\",\n \"syncToken\" : \"AQEAAAAAAwAAAVEa8k3QBgAAAAIFAAABURrz6VoTAQgAAABdN_yWgAkBCgGwXNsj\",\n \"syncTime\" : \"2015-11-18T14:16:11.354Z\",\n \"olderRecordsExist\" : false\n }\n}\n"},{"title":"Incremental Sync","request":"GET /restapi/v1.0/account/400371259008/extension/400371259008/message-sync?syncType=ISync&syncToken=AQEAAAAAAwAAAVEa8k3QBgAAAAIFAAABURrz6VoTAQgAAABdN_yWgAkBCgGwXNsj&recordCount=1&distinctConversations=true\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-sync?syncType=ISync&syncToken=AQEAAAAAAwAAAVEa8k3QBgAAAAIFAAABURrz6VoTAQgAAABdN_yWgAkBCgGwXNsj&recordCount=1&distinctConversations=true\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060296008\",\n \"id\" : 401060296008,\n \"to\" : [ {\n \"phoneNumber\" : \"+1650875583254\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:28:53.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060296008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060296008/content/401060296008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 2335508640601318644,\n \"lastModifiedTime\" : \"2015-11-18T14:28:54.035Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060294008\",\n \"id\" : 401060294008,\n \"to\" : [ {\n \"phoneNumber\" : \"+1650876583254\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:28:28.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060294008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060294008/content/401060294008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 5226857014532753173,\n \"lastModifiedTime\" : \"2015-11-18T14:28:28.413Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060290008\",\n \"id\" : 401060290008,\n \"to\" : [ {\n \"phoneNumber\" : \"+16508783254\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:28:18.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060290008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060290008/content/401060290008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 1817157275107994090,\n \"lastModifiedTime\" : \"2015-11-18T14:28:19.126Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060268008\",\n \"id\" : 401060268008,\n \"to\" : [ {\n \"phoneNumber\" : \"+16505783204\",\n \"location\" : \"San Mateo, CA\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18883770028\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2015-11-18T14:14:19.000Z\",\n \"readStatus\" : \"Read\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 401060268008,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400371259008/extension/400371259008/message-store/401060268008/content/401060268008\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\"\n } ],\n \"direction\" : \"Outbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Test SMS message from Platform server\",\n \"messageStatus\" : \"Sent\",\n \"smsSendingAttemptsCount\" : 1,\n \"conversationId\" : 3250408652258317314,\n \"lastModifiedTime\" : \"2015-11-18T14:14:19.260Z\"\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"ISync\",\n \"syncToken\" : \"AQEAAAAAAwAAAVEa8jJ4BgAAAAIFAAABURsEhnsTAQgAAABdN_yWgAkBCgG87FJ6\",\n \"syncTime\" : \"2015-11-18T14:28:54.035Z\",\n \"olderRecordsExist\" : false\n }\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadMessages] permission granted with extended scope"}]}},"/restapi/v1.0/account/{accountId}/message-store-configuration":{"get":{"tags":["Message Store"],"summary":"Get Message Store Configuration","description":"Returns message store settings.","operationId":"readMessageStoreConfiguration","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retentionPeriod":{"maximum":90,"minimum":7,"type":"integer","description":"Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days"}}}}}}},"x-api-group":"account/message-store-configuration","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-user-permission":"AccountAdministration","x-app-permission":"EditAccounts","x-feature":"AccountAdministration","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/message-store-configuration\n","response":"HTTP 200 OK\n\n{\n \"retentionPeriod\": 90\n}\n"}],"x-error-codes":null},"put":{"tags":["Message Store"],"summary":"Update Message Store Configuration","description":"Updates message store settings.","operationId":"updateMessageStoreConfiguration","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"type":"object","properties":{"retentionPeriod":{"maximum":90,"minimum":7,"type":"integer","description":"Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days"}}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retentionPeriod":{"maximum":90,"minimum":7,"type":"integer","description":"Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days"}}}}}}},"x-api-group":"account/message-store-configuration","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-user-permission":"AccountAdministration","x-app-permission":"EditAccounts","x-feature":"AccountAdministration","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/message-store-configuration\n\n{\n \"retentionPeriod\": 30\n}\n","response":"HTTP 200 OK\n\n{\n \"retentionPeriod\": 30\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"ACT-340","message":"Retention policy cannot be change for HIPAA compliant accounts"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out":{"post":{"tags":["RingOut"],"summary":"Make RingOut Call","description":"Makes a 2-leg RingOut call.","operationId":"createRingOutCall","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"},"forwardingNumberId":{"type":"string","description":"Internal identifier of a forwarding number; returned in response as an 'id' field value. Can be specified instead of the phoneNumber attribute"}},"description":"Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of the user's configured forwarding numbers or an arbitrary number"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of the RingOut call"},"callerId":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"The number which will be displayed to the called party"},"playPrompt":{"type":"boolean","description":"The audio prompt that the calling party hears when the call is connected"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Dialing plan country identifier"}},"description":"Optional. Dialing plan country data. If not specified, then extension home country is applied by default"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a RingOut call"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}}}}}},"x-api-group":"extension/ringout","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"with Phone Number","request":"POST /restapi/v1.0/account/1133926004/extension/1133926004/ring-out\n\n{\n \"from\": {\"phoneNumber\": \"+12053320032\"},\n \"to\": {\"phoneNumber\": \"+16052160005\"},\n \"playPrompt\": true,\n \"country\": { \"id\" : \"44\" }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1133926004/extension/1133926004/ring-out/Y3MxNzE4NDI4NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\",\n \"id\" : \"Y3MxNzE4NDI4NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\",\n \"status\" : {\n \"callStatus\" : \"InProgress\",\n \"callerStatus\" : \"InProgress\",\n \"calleeStatus\" : \"InProgress\"\n }\n}\n"},{"title":"with Forwarding Number ID","request":"POST /restapi/v1.0/account/1133926004/extension/1133926004/ring-out\n\n{\n \"from\": {\"forwardingNumberId\": \"1472341004\"},\n \"to\": {\"phoneNumber\": \"+12052160005\"},\n \"playPrompt\": true,\n \"country\": { \"id\" : \"1\" }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1133926004/extension/1133926004/ring-out/3MxNzE4NDI488NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\",\n \"id\" : \"3MxNzE4NDI488NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\",\n \"status\" : {\n \"callStatus\" : \"InProgress\",\n \"callerStatus\" : \"InProgress\",\n \"calleeStatus\" : \"InProgress\"\n }\n \n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}":{"get":{"tags":["RingOut"],"summary":"Get RingOut Call Status","description":"Returns the status of a 2-leg RingOut call.","operationId":"readRingOutCallStatus","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ringoutId","in":"path","description":"Internal identifier of a RingOut call","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a RingOut call"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}}}}}},"x-api-group":"extension/ringout","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/400162076008/extension/400162076009/ring-out/Y3MxNzE4NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\n","response":"HTTP 200 OK\n\n{\n\t\"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400162076008/extension/400162076009/ring-out/2\",\n \"id\" : \"Y3MxNzE4NDkyODg0NDM5MDJAMTAuNjIuMjkuMzM\",\n \"status\" : {\n \"callStatus\" : \"Success\",\n \"callerStatus\" : \"Success\",\n \"calleeStatus\" : \"Success\"\n }\n \n}\n"}],"x-error-codes":null},"delete":{"tags":["RingOut"],"summary":"Cancel RingOut Call","description":"Cancels a 2-leg RingOut call.","operationId":"deleteRingOutCall","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ringoutId","in":"path","description":"Internal identifier of a RingOut call","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{}}},"x-api-group":"extension/ringout","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/400162076008/extension/400162076009/ring-out/Y3MxNzE4NDk\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout":{"post":{"tags":["RingOut"],"summary":"Make RingOut Call","description":"Makes a 2-leg RingOut call.","operationId":"createRingOutCallDeprecated","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"},"forwardingNumberId":{"type":"string","description":"Internal identifier of a forwarding number; returned in response as an 'id' field value. Can be specified instead of the phoneNumber attribute"}},"description":"Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of the user's configured forwarding numbers or an arbitrary number"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of the RingOut call"},"callerId":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format"}},"description":"The number which will be displayed to the called party"},"playPrompt":{"type":"boolean","description":"The audio prompt that the calling party hears when the call is connected"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Dialing plan country identifier"}},"description":"Optional. Dialing plan country data. If not specified, then extension home country is applied by default"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a RingOut call","format":"int64"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}}}}}},"deprecated":true,"x-api-group":"extension/ringout","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}":{"get":{"tags":["RingOut"],"summary":"Get RingOut Call Status","description":"Returns status of a 2-leg RingOut call.","operationId":"readRingOutCallStatusDeprecated","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ringoutId","in":"path","description":"Internal identifier of a RingOut call","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a RingOut call"},"uri":{"type":"string"},"status":{"type":"object","properties":{"callStatus":{"type":"string","description":"Status of a call","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"callerStatus":{"type":"string","description":"Status of a calling party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]},"calleeStatus":{"type":"string","description":"Status of a called party","enum":["Invalid","Success","InProgress","Busy","NoAnswer","Rejected","GenericError","Finished","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser"]}},"description":"RingOut status information"}}}}}}},"deprecated":true,"x-api-group":"extension/ringout","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [ringOutId] is not found"}]},"delete":{"tags":["RingOut"],"summary":"Cancel RingOut Call","description":"Cancels a 2-leg RingOut call.","operationId":"deleteRingOutCallDeprecated","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ringoutId","in":"path","description":"Internal identifier of a RingOut call","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content","content":{}}},"deprecated":true,"x-api-group":"extension/ringout","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"Time-based","x-app-permission":"RingOut","x-docs-level":"Public","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact":{"get":{"tags":["External Contacts"],"summary":"Get Contact List","description":"Returns user personal contacts.","operationId":"listContacts","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"startsWith","in":"query","description":"If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive","schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Sorts results by the specified property","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["FirstName","LastName","Company"]}}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"phoneNumber","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"link to the list of user personal contacts"},"records":{"type":"array","description":"List of personal contacts from the extension address book","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"groups":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of address book groups"}},"description":"Information on address book groups"}}}}}}},"x-api-group":"extension/address-book/contact","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadContacts","x-user-permission":"ReadPersonalContacts","x-feature":"ReadPersonalContacts","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact?sortBy=FirstName\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact?sortBy=FirstName\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768714008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768714008,\n \"firstName\" : \"Duncan\",\n \"lastName\" : \"Idaho\",\n \"mobilePhone\" : \"+16506667788\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768715008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768715008,\n \"firstName\" : \"Feyd-Rautha\",\n \"lastName\" : \"Harkonnen\",\n \"mobilePhone\" : \"+16507778899\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768712008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768712008,\n \"firstName\" : \"Irulan\",\n \"lastName\" : \"Corrino\",\n \"mobilePhone\" : \"+16504445566\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768710008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768710008,\n \"firstName\" : \"Leto\",\n \"lastName\" : \"Atreides\",\n \"mobilePhone\" : \"+16503334455\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768709008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768709008,\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Atreides\",\n \"mobilePhone\" : \"+16502223344\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768713008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768713008,\n \"firstName\" : \"Shaddam\",\n \"lastName\" : \"Corrino\",\n \"mobilePhone\" : \"+16505556677\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact/419768707008\",\n \"availability\" : \"Alive\",\n \"id\" : 419768707008,\n \"firstName\" : \"Vladimir\",\n \"lastName\" : \"Harkonnen\",\n \"mobilePhone\" : \"+16501112233\",\n \"birthday\" : \"1970-01-01T00:00:00.000Z\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 7,\n \"pageStart\" : 0,\n \"pageEnd\" : 6\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact?sortBy=FirstName&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/contact?sortBy=FirstName&page=1&perPage=100\"\n }\n },\n \"groups\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/414988656008/extension/414988656008/address-book/group\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]},"post":{"tags":["External Contacts"],"summary":"Create Contact","description":"Creates personal user contact.","operationId":"createContact","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"dialingPlan","in":"query","description":"A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The default value is home country of the current extension","schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}}},"required":false},"responses":{"200":{"description":"New Contact","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}}}},"400":{"description":"Contact cannot be created: max contacts count reached ($limit)","content":{}}},"x-api-group":"extension/address-book/contact","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/extension/~/address-book/contact\n\n{\n \"firstName\": \"Charlie\",\n \"lastName\": \"Williams\",\n \"businessPhone\": \"+15551234567\",\n \"businessAddress\": {\n \"street\": \"20 Davis Dr.\",\n \"city\": \"Belmont\",\n \"state\": \"CA\",\n \"zip\": 94002\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004\",\n \"availability\": \"Alive\",\n \"id\": 623045004,\n \"firstName\": \"Charlie\",\n \"lastName\": \"Williams\",\n \"businessAddress\": {\n \"street\": \"20 Davis Dr.\",\n \"city\": \"Belmont\",\n \"state\": \"CA\",\n \"zip\": 94002\n },\n \"businessPhone\": \"+15551234567\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Get Contact","description":"Returns contact(s) by ID(s). Batch request is supported.","operationId":"readContact","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"contactId","in":"path","description":"Internal identifier of a contact record in the RingCentral database","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}}}}},"x-api-group":"extension/address-book/contact","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadContacts","x-user-permission":"ReadPersonalContacts","x-feature":"ReadPersonalContacts","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1707266004\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1707266004\",\n \"availability\" : \"Alive\",\n \"id\" : 1707266004,\n \"company\" : \"MyCompany\",\n \"jobTitle\" : \"Musician\",\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\",\n \"businessAddress\" : {\n \"city\" : \"Reykjavik\",\n \"country\" : \"Iceland\"\n },\n \"homePhone\" : \"+18764545488\"\n}\n"}],"x-error-codes":null},"put":{"tags":["External Contacts"],"summary":"Update Contact","description":"Updates personal contact information by contact ID(s). Batch request is supported","operationId":"updateContact","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"contactId","in":"path","description":"Internal identifier of a contact record in the RingCentral database","required":true,"schema":{"type":"integer"}},{"name":"dialingPlan","in":"query","description":"A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The default value is home country of the current extension","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}}},"required":false},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}}}}},"x-api-group":"extension/address-book/contact","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1707266004\n\n{\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\",\n \"company\" : \"MyCompany\",\n \"businessAddress\": {\n \"city\": \"Reykjavik\",\n \"country\": \"ISL\"\n },\n \"jobTitle\" : \"Musician\",\n \"homePhone\" : \"+18764545488\"\n} \n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1707266004\",\n \"availability\" : \"Alive\",\n \"id\" : 1707266004,\n \"company\" : \"MyCompany\",\n \"jobTitle\" : \"Musician\",\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\",\n \"businessAddress\" : {\n \"city\" : \"Reykjavik\",\n \"country\" : \"Iceland\"\n },\n \"homePhone\" : \"+18764545488\"\n \n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [Contacts] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"delete":{"tags":["External Contacts"],"summary":"Delete Contact","description":"Deletes contact(s) by ID(s). Batch request is supported.","operationId":"deleteContact","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"contactId","in":"path","description":"Internal identifier of a contact record in the RingCentral database","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{}}},"x-api-group":"extension/address-book/contact","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-docs-level":"Public","x-http-examples":[{"title":"Single Contact","request":"DELETE /restapi/v1.0/account/403227052008/extension/403227052008/address-book/contact/404831376017\n","response":"HTTP 204 No Content\n"},{"title":"Multiple Contacts","request":"DELETE /restapi/v1.0/account/403227052008/extension/403227052008/address-book/contact/404831376008, 404831371008\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync":{"get":{"tags":["External Contacts"],"summary":"Address Book Synchronization","description":"Synchronizes user contacts.","operationId":"syncAddressBook","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"syncType","in":"query","description":"Type of synchronization","schema":{"type":"string","enum":["FSync","ISync"]}},{"name":"syncToken","in":"query","description":"Value of syncToken property of the last sync request response","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Number of records per page to be returned. The max number of records is 250, which is also the default. For 'FSync' if the number of records exceeds the parameter value (either specified or default), all of the pages can be retrieved in several requests. For 'ISync' if the number of records exceeds the page size, the number of incoming changes to this number is limited","schema":{"type":"integer"}},{"name":"pageId","in":"query","description":"Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body","schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the contact","example":"https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004"},"availability":{"type":"string","description":"This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive`","enum":["Alive","Deleted","Purged"]},"email":{"type":"string","description":"Email of the contact","example":"charlie.williams@example.com"},"id":{"type":"integer","description":"Internal identifier of the contact","example":623045004},"notes":{"type":"string","description":"Notes for the contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of the contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of the contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of the contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of the contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of the contact","format":"date-time"},"webPage":{"type":"string","description":"The contact home page URL","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of the contact","example":"J"},"nickName":{"type":"string","description":"Nick name of the contact","example":"The Boss"},"email2":{"type":"string","description":"2nd email of the contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"3rd email of the contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of the contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of the contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"homeAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"otherAddress":{"type":"object","properties":{"street":{"type":"string","description":"Street address","example":"20 Davis Dr."},"city":{"type":"string","description":"City name","example":"Belmont"},"country":{"type":"string","description":"Country name"},"state":{"type":"string","description":"State/province name","example":"CA"},"zip":{"type":"string","description":"Zip/Postal code","example":"94002"}}},"ringtoneIndex":{"type":"string","description":"Contact ringtone. Max number of symbols is 64"}}}},"syncInfo":{"type":"object","properties":{"syncType":{"type":"string","enum":["FSync","ISync"]},"syncToken":{"type":"string"},"syncTime":{"type":"string","format":"date-time"},"olderRecordsExist":{"type":"boolean","default":false}}},"nextPageId":{"type":"integer","format":"int64"},"nextPageUri":{"type":"string","format":"uri"}}}}}}},"x-api-group":"extension/address-book-sync","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadContacts","x-user-permission":"ReadPersonalContacts","x-feature":"ReadPersonalContacts","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Full Sync","request":"GET /restapi/v1.0/account/1594606004/extension/1594606004/address-book-sync?syncType=FSync\n","response":"HTTP 200 OK\n\n {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1707266004\",\n \"availability\" : \"Alive\",\n \"id\" : 1707266004,\n \"company\" : \"MyCompany\",\n \"jobTitle\" : \"Musician\",\n \"firstName\" : \"John\",\n \"lastName\" : \"Smith\",\n \"businessAddress\" : {\n \"city\" : \"Reykjavik\",\n \"country\" : \"Iceland\"\n },\n \"homePhone\" : \"+18764545488\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1711342004\",\n \"availability\" : \"Alive\",\n \"id\" : 1711342004,\n \"firstName\" : \"Mira\",\n \"lastName\" : \"Soul\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1711343004\",\n \"availability\" : \"Alive\",\n \"id\" : 1711343004,\n \"firstName\" : \"Mary\",\n \"lastName\" : \"Rose\",\n \"homePhone\" : \"+18764545488\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1711344004\",\n \"availability\" : \"Alive\",\n \"id\" : 1711344004,\n \"jobTitle\" : \"Designer\",\n \"firstName\" : \"Iren\",\n \"lastName\" : \"Fox\",\n \"businessAddress\" : {\n \"city\" : \"New York\",\n \"country\" : \"United States\"\n },\n \"homePhone\" : \"+18763245477\"\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"FSync\",\n \"syncToken\" : \"HgAAAABfC8G0AQEAAAAAAAAAGXPgavg\",\n \"syncTime\" : \"2018-09-13T10:43:59.342Z\"\n }\n}\n"},{"title":"Incremental Sync","request":"GET /restapi/v1.0/account/1594606004/extension/1594606004/address-book-sync?syncType=ISync&syncToken=HgAAAABfC8G0AQEAAAAAAAAAGXPgavg\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book-sync?syncType=ISync&syncToken=HgAAAABfC8G0AQEAAAAAAAAAGXPgavg&perPage=max\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1712721004\",\n \"availability\" : \"Alive\",\n \"id\" : 1712721004,\n \"firstName\" : \"Paul\",\n \"lastName\" : \"Soul\",\n \"homePhone\" : \"+18764761488\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book/contact/1712722004\",\n \"availability\" : \"Alive\",\n \"id\" : 1712722004,\n \"firstName\" : \"Jane\",\n \"lastName\" : \"Smith\",\n \"homePhone\" : \"+18721345477\"\n } ],\n \"syncInfo\" : {\n \"syncType\" : \"ISync\",\n \"syncToken\" : \"HgAAAABfC8G0AQEAAAAAAAAAHXSNruE\",\n \"syncTime\" : \"2018-09-13T10:52:10.501Z\"\n },\n \"nextPageId\" : 29,\n \"nextPageUri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/address-book-sync?syncType=ISync&pageId=29&perPage=max\"\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite":{"get":{"tags":["External Contacts"],"summary":"Get Favorite Contact List","description":"Returns the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).","operationId":"listFavoriteContacts","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"Favorite Contact List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}}}}}}}}},"x-api-group":"extension/favorite","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-user-permission":"ReadPersonalContacts","x-feature":"ReadPersonalContacts","x-app-permission":"ReadContacts","x-docs-level":"Public","x-availability":"High","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-http-examples":[{"request":"GET /restapi/v1.0/account/1594606004/extension/1594606004/favorite\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/favorite\",\n \"records\" : [ {\n \"id\" : 1,\n \"extensionId\" : \"1594660004\"\n }, {\n \"id\" : 2,\n \"contactId\" : \"1707266004\"\n }, {\n \"id\" : 3,\n \"contactId\" : \"1711344004\"\n } ]\n}\n"}],"x-error-codes":null},"put":{"tags":["External Contacts"],"summary":"Update Favorite Contact List","description":"Updates the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).**Please note**: currently personal address book size is limited to 10 000 contacts.","operationId":"updateFavoriteContactList","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}}}}}}},"required":false},"responses":{"200":{"description":"Favorite Contact List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"extensionId":{"type":"string"},"accountId":{"type":"string"},"contactId":{"type":"string"}}}}}}}}}},"x-api-group":"extension/favorite","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/1594606004/extension/1594606004/favorite\n\n{\n \"records\":[\n { \"id\" : \"1\",\n \"contactId\" : \"1711344004\"},\n { \"id\" : \"2\",\n \"contactId\" : \"1707266004\"},\n { \"id\" : \"3\",\n \"extensionId\" : \"1594660004\"}\n ]\n }\n","response":"HTTP 201 Created\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1594606004/extension/1594606004/favorite\",\n \"records\" : [ {\n \"id\" : 1,\n \"contactId\" : \"1711344004\"\n }, {\n \"id\" : 2,\n \"contactId\" : \"1707266004\"\n }, {\n \"id\" : 3,\n \"extensionId\" : \"1594660004\"\n } ]\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [records] value is invalid."},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [Contacts] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]}},"/restapi/v1.0/account/{accountId}/directory/entries/search":{"post":{"tags":["Internal Contacts"],"summary":"Search Company Directory Entries","description":"Returns contact information on corporate users of federated accounts according to the specified filtering and ordering.","operationId":"searchDirectoryEntries","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"searchString":{"type":"string","description":"String value to filter the contacts. The value specified is searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`, `jobTitle`, `department`"},"searchFields":{"type":"array","items":{"type":"string","enum":["firstName","lastName","extensionNumber","phoneNumber","email","jobTitle","department"]}},"showFederated":{"type":"boolean","description":"If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case","default":true},"extensionType":{"type":"string","description":"Type of extension to filter the contacts. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","IvrMenu","Limited","ApplicationExtension","Site","Bot","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"orderBy":{"type":"array","description":"Sorting settings","items":{"type":"object","properties":{"index":{"type":"integer","description":"Sorting priority index, starting from '1'. Optional if only one element in `orderBy` array is specified"},"fieldName":{"type":"string","description":"Field name by which to sort the contacts","enum":["firstName","lastName","extensionNumber","phoneNumber","email","jobTitle","department"]},"direction":{"type":"string","description":"Sorting direction","enum":["Asc","Desc"]}}}},"page":{"type":"integer"},"perPage":{"type":"integer"}}}}},"required":false},"responses":{"200":{"description":"Paged collection of all contacts information for a given account according to filtering and ordering. Records can be empty if no data found","content":{"application/json":{"schema":{"type":"object","properties":{"paging":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"records":{"type":"array","items":{"type":"object","properties":{"account":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"department":{"type":"string"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"id":{"type":"string"},"jobTitle":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}},"profileImage":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"status":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Current request cannot be processed due to error in its body and/or url","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Some unexpected error during current request processing.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"503":{"description":"Network error during request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-api-group":"account/directory/entries/search","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-auth-required":true,"x-internal-api":false,"x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/directory/(.*)","x-rewrite-uri-to":"/account-directory/v1/account/$1/directory/$2","x-service-interface":"rest","x-service-name":"adg","x-service-version":"v1","x-throttling-group":"Heavy","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/directory/entries/search\n\n{\n \"searchString\": \"John\",\n \"extensionType\": \"User\",\n \"orderBy\": [ {\n \"index\": 1,\n \"fieldName\": \"firstName\",\n \"direction\": \"Desc\"\n }, {\n \"index\": 2,\n \"fieldName\": \"email\",\n \"direction\": \"Desc\"\n } ],\n \"page\": 2,\n \"perPage\": 25\n}\n","response":"HTTP 200 OK\n\n{\n \"records\": [{\n \"id\": \"12345\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"jobTitle\": \"CEO\",\n \"department\": \"Sales\",\n \"email\": \"john.smith@example.com\",\n \"extensionNumber\": \"103\",\n \"account\": {\n \"id\": \"2002\"\n },\n \"site\": {\n \"code\": \"10\",\n \"name\": \"Main Site\",\n \"id\": \"main-site\"\n },\n \"phoneNumbers\": [ {\n \"phoneNumber\": \"+12022372134\",\n \"usageType\": \"DirectNumber\",\n \"type\": \"FaxOnly\"\n }, {\n \"phoneNumber\": \"+12125672134\",\n \"usageType\": \"DirectNumber\",\n \"type\": \"VoiceFax\"\n }, {\n \"phoneNumber\": \"+12485724134\",\n \"usageType\": \"ContactNumber\",\n }, {\n \"phoneNumber\": \"+13035672134\",\n \"usageType\": \"ForwardedNumber\",\n }, {\n \"phoneNumber\": \"+16029472302\",\n \"usageType\": \"MobileNumber\"\n }\n ],\n \"profileImage\": {\n \"uri\": \"...\",\n \"etag\": \"...\"\n }\n }, ...\n ],\n \"paging\" : {\n \"page\": 2,\n \"totalPages\": 2,\n \"perPage\": 25,\n \"totalElements\": 26,\n \"pageStart\": 25,\n \"pageEnd\": 25\n }\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/directory/entries/{entryId}":{"get":{"tags":["Internal Contacts"],"summary":"Get Corporate Directory Entry","description":"Returns contact information on a particular corporate user of a federated account.","operationId":"readDirectoryEntry","parameters":[{"name":"entryId","in":"path","description":"Internal identifier of extension to read information for","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of owning account","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Contact information for given parameters. If value doesn't found then empty body will be returned","content":{"application/json":{"schema":{"type":"object","properties":{"account":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"department":{"type":"string"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"id":{"type":"string"},"jobTitle":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}},"profileImage":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"status":{"type":"string"},"type":{"type":"string"}}}}}},"400":{"description":"Current request cannot be processed due to error in its body and/or url","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Some unexpected error during current request processing","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"503":{"description":"Network error during request. One should check connection between ADG processing node and ADX data node","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-api-group":"account/directory/entries/single","x-app-permission":"ReadAccounts","x-auth-required":true,"x-internal-api":false,"x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/directory/(.*)","x-rewrite-uri-to":"/account-directory/v1/account/$1/directory/$2","x-service-interface":"rest","x-service-name":"adg","x-service-version":"v1","x-throttling-group":"Medium","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/directory/entries/400248807008\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"400248807008\",\n \"type\" : \"User\",\n \"status\" : \"Enabled\",\n \"firstName\" : \"Jane\",\n \"lastName\" : \"Bond\",\n \"email\" : \"jbond@mycompany.example.com\",\n \"extensionNumber\" : \"101\",\n \"account\" : {\n \"id\" : \"400248807008\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/directory/entries":{"get":{"tags":["Internal Contacts"],"summary":"Get Company Directory Entries","description":"Returns contact information on corporate users of federated accounts. Please note: 1. `User`, `DigitalUser`, `VirtualUser` and `FaxUser` types are returned as `User` type. 2. `ApplicationExtension` type is not returned. 3. Only extensions in `Enabled`, `Disabled` and `NotActivated` state are returned.","operationId":"listDirectoryEntries","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"showFederated","in":"query","description":"If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case","schema":{"type":"boolean","default":true}},{"name":"type","in":"query","description":"Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","schema":{"type":"string","enum":["User","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ParkLocation","Limited"]}},{"name":"page","in":"query","description":"Page number","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","description":"Records count to be returned per one page. The default value is 1000. Specific keyword values: `all` - all records are returned in one page; `max` - maximum count of records that can be returned in one page","schema":{"maximum":2000,"type":"integer","default":1000}},{"name":"siteId","in":"query","description":"Internal identifier of the business site to which extensions belong","schema":{"type":"string"}},{"name":"If-None-Match","in":"header","description":"If-None-Match","schema":{"type":"string"}}],"responses":{"200":{"description":"Paged collection of all contacts information for a given account. Records can be empty if no data found.","content":{"application/json":{"schema":{"type":"object","properties":{"paging":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"records":{"type":"array","items":{"type":"object","properties":{"account":{"type":"object","properties":{"companyName":{"type":"string"},"federatedName":{"type":"string"},"id":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}},"department":{"type":"string"},"email":{"type":"string"},"extensionNumber":{"type":"string"},"firstName":{"type":"string","description":"First name of a contact, for user extensions only"},"lastName":{"type":"string","description":"Last name of a contact, for user extensions only"},"name":{"type":"string","description":"Name of a contact, for non-user extensions"},"id":{"type":"string"},"jobTitle":{"type":"string"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}},"profileImage":{"type":"object","properties":{"etag":{"type":"string"},"uri":{"type":"string"}}},"site":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"}}},"status":{"type":"string"},"type":{"type":"string"}}}}}}}}},"400":{"description":"Current request cannot be processed due to error in its body and/or url.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Some unexpected error during current request processing.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"503":{"description":"Network error during request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-api-group":"account/directory/entries","x-app-permission":"ReadAccounts","x-auth-required":true,"x-internal-api":false,"x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/directory/(.*)","x-rewrite-uri-to":"/account-directory/v1/account/$1/directory/$2","x-service-interface":"rest","x-service-name":"adg","x-service-version":"v1","x-throttling-group":"Medium","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/directory/entries\n","response":"HTTP 200 OK\n\n{\n \"records\": [{\n \"id\": \"12345\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"jobTitle\": \"CEO\",\n \"department\": \"Sales\",\n \"email\": \"john.smith@example.com\",\n \"extensionNumber\": \"103\",\n \"account\": {\n \"id\": \"2002\"\n },\n \"site\": {\n \"code\": \"10\",\n \"name\": \"Main Site\",\n \"id\": \"main-site\"\n },\n \"phoneNumbers\": [ {\n \"phoneNumber\": \"+12022372134\",\n \"usageType\": \"DirectNumber\",\n \"type\": \"FaxOnly\"\n }, {\n \"phoneNumber\": \"+12125672134\",\n \"usageType\": \"DirectNumber\",\n \"type\": \"VoiceFax\"\n }, {\n \"phoneNumber\": \"+12485724134\",\n \"usageType\": \"ContactNumber\",\n }, {\n \"phoneNumber\": \"+13035672134\",\n \"usageType\": \"ForwardedNumber\",\n }, {\n \"phoneNumber\": \"+16029472302\",\n \"usageType\": \"MobileNumber\"\n }\n ],\n \"profileImage\": {\n \"uri\": \"...\",\n \"etag\": \"...\"\n }\n }, ...\n ],\n \"paging\" : {\n \"page\": 2,\n \"totalPages\": 2,\n \"perPage\": 25,\n \"totalElements\": 26,\n \"pageStart\": 25,\n \"pageEnd\": 25\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/directory/federation":{"get":{"tags":["Internal Contacts"],"summary":"Get Account Federation","description":"Returns information on a federation and associated accounts.","operationId":"readAccountFederation","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"RCExtensionId","in":"header","description":"RCExtensionId","schema":{"type":"string"}}],"responses":{"200":{"description":"List of found federations. Records array can be empty if no data found","content":{"application/json":{"schema":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"companyName":{"type":"string"},"conflictCount":{"type":"integer","format":"int32"},"federatedName":{"type":"string"},"id":{"type":"string"},"linkCreationTime":{"type":"string"},"mainNumber":{"type":"object","properties":{"formattedPhoneNumber":{"type":"string"},"phoneNumber":{"type":"string"},"type":{"type":"string"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"usageType":{"type":"string","description":"Usage type of a phone number","enum":["MobileNumber","ContactNumber","DirectNumber","ForwardedNumber","ExternalMobileNumber"]}}}}}},"creationTime":{"type":"string"},"displayName":{"type":"string"},"id":{"type":"string"},"lastModifiedTime":{"type":"string"}}}}}},"400":{"description":"Current request cannot be processed due to error in its body and/or url","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Some unexpected error during current request processing.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"503":{"description":"Network error during request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-api-group":"account/directory/federation","x-app-permission":"ReadAccounts","x-auth-required":true,"x-internal-api":false,"x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/directory/(.*)","x-rewrite-uri-to":"/account-directory/v1/account/$1/directory/$2","x-service-interface":"rest","x-service-name":"adg","x-service-version":"v1","x-throttling-group":"Medium","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/directory/federation\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"1721008\",\n \"displayName\" : \"My federation\",\n \"creationTime\" : \"2017-06-09T10:20:22Z\",\n \"lastModifiedTime\" : \"2017-06-09T10:29:43Z\",\n \"accounts\" : [ {\n \"id\" : \"400248793008\",\n \"companyName\" : \"My company\",\n \"federatedName\" : \"My federation\",\n \"linkCreationTime\" : \"2017-06-09T10:22:48Z\",\n \"mainNumber\" : {\n \"phoneNumber\" : \"+18772009098\",\n \"formattedPhoneNumber\" : \"(877) 200-9098\"\n },\n \"conflictCount\" : 0\n }, {\n \"id\" : \"400248807008\",\n \"companyName\" : \"My company\",\n \"federatedName\" : \"My federation\",\n \"linkCreationTime\" : \"2017-06-09T10:29:43Z\",\n \"mainNumber\" : {\n \"phoneNumber\" : \"+14159130525\",\n \"formattedPhoneNumber\" : \"(415) 913-0525\"\n },\n \"conflictCount\" : 3\n } ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence":{"get":{"tags":["Presence"],"summary":"Get User Presence Status","description":"Returns presence status of an extension or several extensions by their ID(s). Batch request is supported. The 'presenceStatus' is returned as Offline (the parameters 'telephonyStatus', 'message', 'userStatus' and 'dndStatus' are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'.","operationId":"readUserPresenceStatus","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"detailedTelephonyState","in":"query","description":"Whether to return detailed telephony state","schema":{"type":"boolean"}},{"name":"sipData","in":"query","description":"Whether to return SIP data","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a presence info resource"},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"message":{"type":"string","description":"Custom status message (as previously published by user)"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"RingCentral Meetings presence","enum":["Connected","Disconnected"]},"activeCalls":{"type":"array","description":"Information on active calls","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}}}}}}}},"x-api-group":"extension/presence","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadPresence","x-user-permission":"ReadPresenceStatus","x-feature":"ReadPresenceStatus","x-docs-level":"Public","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call"},"direction":{"type":"string","description":"Call direction","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"startTime":{"type":"string","description":"Time when the call is actually started"},"sessionId":{"type":"string","description":"Internal identifier of a call session"},"telephonyStatus":{"type":"string","description":"Telephony call status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"terminationType":{"type":"string","description":"Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices","enum":["final","intermediate"]},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}},{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"activeCalls":{"type":"array","description":"List of the latest 7 active calls on extension","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"totalActiveCalls":{"type":"integer","description":"Total number of active calls on extension at the present moment"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-http-examples":[{"title":"Simple Presence Status","request":"GET /restapi/v1.0/account/403228676008/extension/403228676008/presence\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403228676008/extension/403228676008/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403228676008/extension/403228676008\",\n \"id\": 403228676008,\n \"extensionNumber\": \"101\"\n },\n \"presenceStatus\": \"Available\",\n \"telephonyStatus\": \"NoCall\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": true\n}\n"},{"title":"Detailed Presence Status","request":"GET /restapi/v1.0/account/403228676008/extension/403228676008/presence?sipData=true&detailedTelephonyPresence=true\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403228676008/extension/403228676008/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403228676008/extension/403228676008\",\n \"id\": 403228676008,\n \"extensionNumber\": \"101\"\n },\n \"presenceStatus\": \"Available\",\n \"telephonyStatus\": \"Ringing\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": true,\n \"activeCalls\": [ {\n \"id\": \"Y3MxNzE4NDAwMTIyMjc2NTY2MUAxMC42Mi4xOC4xMg\",\n \"direction\": \"Outbound\",\n \"fromName\": \"John Smith\",\n \"queueCall\": true,\n \"from\": \"+18442054090\",\n \"to\": \"+79500109654\",\n \"telephonyStatus\": \"Ringing\",\n \"sipData\": {\n \"toTag\": \"blf\",\n \"fromTag\": \"cs17184001222765661-1\",\n \"remoteUri\": \"sip:+79500109654@ringcentral.com\",\n \"localUri\": \"sip:+18442054090@ringcentral.com\"\n },\n \"sessionId\": \"407257657008\",\n \"startTime\": \"2018-10-23T12:19:01.499+0000\",\n \"onBehalfOf\": \"\",\n \"partyId\": \"cs17184001222765661-1\",\n \"telephonySessionId\": \"Y3MxNzE4NDAwMTIyMjc2NTY2MUAxMC42Mi4xOC4xMg\",\n \"callInfo\":{ \n \"primary\":{ \n \"type\":\"QueueName\",\n \"value\":\"Sales\"\n },\n \"additional\":{ \n \"type\":\"CallerIdName\",\n \"value\":\"John Smith\"\n }\n }\n }]\n}\n"}],"x-error-codes":null},"put":{"tags":["Presence"],"summary":"Update User Presence Status","description":"Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.","operationId":"updateUserPresenceStatus","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"userStatus":{"type":"string","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","enum":["TakeAllCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly","DoNotAcceptAnyCalls","Unknown"]},"message":{"maxLength":75,"minLength":0,"type":"string"},"allowSeeMyPresence":{"type":"boolean","default":false},"ringOnMonitoredCall":{"type":"boolean","default":false},"pickUpCallsOnHold":{"type":"boolean","default":false}}}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the presence resource"},"userStatus":{"type":"string","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","enum":["TakeAllCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly","DoNotAcceptAnyCalls","Unknown"]},"message":{"maxLength":75,"minLength":0,"type":"string"},"allowSeeMyPresence":{"type":"boolean","default":false},"ringOnMonitoredCall":{"type":"boolean","default":false},"pickUpCallsOnHold":{"type":"boolean","default":false},"activeCalls":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"meetingStatus":{"type":"string","description":"Meetings presence status","enum":["Connected","Disconnected"]},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]}}}}}}},"x-api-group":"extension/presence","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditPresence","x-docs-level":"Public","x-feature":"EditPresenceStatus","x-notifications":[{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"},"event":{"type":"string","description":"Event filter URI"},"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"from":{"type":"string","description":"Phone number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"},"recUrl":{"type":"string","description":"File containing recorded caller name"},"pn_ttl":{"type":"integer","description":"Notification lifetime value in seconds, the default value is 30 seconds"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}},{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"pn_apns":{"type":"object","properties":{"aps":{"type":"object","properties":{"content-available":{"type":"integer","description":"If the value is '1' then notification is turned on even if the application is in background"}},"description":"APS (Apple Push Service) information/ priority data"}},"description":"APNS (Apple Push Notification Service) information"},"event":{"type":"string","description":"Event filter URI"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"timestamp":{"type":"string","description":"The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"extensionId":{"type":"string","description":"Internal identifier of an extension","default":"~"},"action":{"type":"string","description":"Calling action, for example 'StartRing'"},"sessionId":{"type":"string","description":"Identifier of a call session"},"serverId":{"type":"string","description":"Identifier of a server"},"from":{"type":"string","description":"Phone number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Caller name"},"to":{"type":"string","description":"Phone number of a callee"},"toName":{"type":"string","description":"Callee name"},"sid":{"type":"string","description":"Unique identifier of a session"},"toUrl":{"type":"string","description":"SIP proxy registration name"},"srvLvl":{"type":"string","description":"User data"},"srvLvlExt":{"type":"string","description":"User data"},"recUrl":{"type":"string","description":"File containing recorded caller name"},"pn_ttl":{"type":"integer","description":"Notification lifetime value in seconds, the default value is 30 seconds"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}}}],"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/255537016/extension/255537016/presence\n\n {\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"message\": \"Available till 7 pm\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": true,\n \"pickUpCallsOnHold\": true\n }\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\",\n \"id\": 255537016,\n \"extensionNumber\": \"101\"\n },\n \"presenceStatus\": \"Available\",\n \"telephonyStatus\": \"NoCall\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"meetingStatus\": \"Disconnected\",\n \"message\": \"Available till 7 pm\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": true,\n \"pickUpCallsOnHold\": true\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/presence":{"get":{"tags":["Presence"],"summary":"Get User Presence Status List","description":"Returns presence status of all extensions of an account. Please note: The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department, Announcement Only, Voicemail (Take Messages Only), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.","operationId":"readAccountPresence","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"detailedTelephonyState","in":"query","description":"Whether to return detailed telephony state","schema":{"type":"boolean"}},{"name":"sipData","in":"query","description":"Whether to return SIP data","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Page number for account presence information","schema":{"type":"integer","format":"int32"}},{"name":"perPage","in":"query","description":"Number for account presence information items per page","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of account presence resource"},"records":{"type":"array","description":"List of Prompts","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a presence info resource"},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only.","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension number (usually 3 or 4 digits)"}},"description":"Information on extension, for which this presence data is returned"},"message":{"type":"string","description":"Custom status message (as previously published by user)"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"meetingStatus":{"type":"string","description":"RingCentral Meetings presence","enum":["Connected","Disconnected"]},"activeCalls":{"type":"array","description":"Information on active calls","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound"]},"queueCall":{"type":"boolean","description":"Identifies if a call belongs to the call queue"},"from":{"type":"string","description":"Phone number or extension number of a caller. For GCM transport type '_from' property should be used"},"fromName":{"type":"string","description":"Name of a caller"},"to":{"type":"string","description":"Phone number or extension number of a callee"},"toName":{"type":"string","description":"Name of a callee"},"startTime":{"type":"string","description":"Time when the call is actually started"},"telephonyStatus":{"type":"string","description":"Telephony presence status","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sipData":{"type":"object","properties":{"callId":{"type":"string"},"toTag":{"type":"string"},"fromTag":{"type":"string"},"remoteUri":{"type":"string"},"localUri":{"type":"string"},"rcSessionId":{"type":"string"}}},"sessionId":{"type":"string"},"telephonySessionId":{"type":"string","description":"Telephony identifier of a call session"},"onBehalfOf":{"type":"string","description":"Extension ID of the call owner on whose behalf a call is performed"},"partyId":{"type":"string","description":"Internal identifier of a call party"},"terminationType":{"type":"string"},"callInfo":{"type":"object","description":"Primary/additional CQ information","properties":{"primary":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 1' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Primary call session information. Supported for Call Queues only"},"additional":{"type":"object","properties":{"type":{"type":"string","description":"Call information to be displayed as 'Line 2' for a call queue call session","enum":["PhoneNumberLabel","PhoneNumber","QueueExtension","QueueName","CallerIdName","CallerIdNumber","None"]},"value":{"type":"string","description":"Call information value"}},"description":"Additional call session information. Supported for Call Queues only"}}}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/presence","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadPresence","x-user-permission":"ReadPresenceStatus","x-docs-level":"Public","x-feature":"ReadPresenceStatus","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension. Optional parameter","default":"~"},"telephonyStatus":{"type":"string","description":"Telephony presence status. Returned if telephony status is changed.","enum":["NoCall","CallConnected","Ringing","OnHold","ParkedCall"]},"sequence":{"type":"integer","description":"Order number of a notification to state the chronology"},"presenceStatus":{"type":"string","description":"Aggregated presence status, calculated from a number of sources","enum":["Offline","Busy","Available"]},"userStatus":{"type":"string","description":"User-defined presence status (as previously published by the user)","enum":["Offline","Busy","Available"]},"dndStatus":{"type":"string","description":"Extended DnD (Do not Disturb) status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptDepartmentCalls","TakeDepartmentCallsOnly"]},"allowSeeMyPresence":{"type":"boolean","description":"If 'True' enables other extensions to see the extension presence status"},"ringOnMonitoredCall":{"type":"boolean","description":"If 'True' enables to ring extension phone, if any user monitored by this extension is ringing"},"pickUpCallsOnHold":{"type":"boolean","description":"If 'True' enables the extension user to pick up a monitored line on hold"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-http-examples":[{"request":"GET /restapi/v1.0/account/255537016/presence?perPage=3&page=2\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/presence?page=2&perPage=3\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/256440016/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/256440016\",\n \"id\": 256440016,\n \"extensionNumber\": \"102\"\n },\n \"presenceStatus\": \"Available\",\n \"telephonyStatus\": \"NoCall\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": false\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/349469016/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/349469016\",\n \"id\": 349469016,\n \"extensionNumber\": \"201\"\n },\n \"presenceStatus\": \"Offline\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/513818017/presence\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/513818017\",\n \"id\": 513818017,\n \"extensionNumber\": \"106\"\n },\n \"presenceStatus\": \"Available\",\n \"telephonyStatus\": \"NoCall\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": false\n }\n ],\n \"paging\": {\n \"page\": 2,\n \"totalPages\": 8,\n \"perPage\": 3,\n \"totalElements\": 23,\n \"pageStart\": 3,\n \"pageEnd\": 5\n },\n \"navigation\": {\n \"nextPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/presence?page=3&perPage=3\"},\n \"previousPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/presence?page=1&perPage=3\"},\n \"firstPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/presence?page=1&perPage=3\"},\n \"lastPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/presence?page=8&perPage=3\"}\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-queues/{groupId}/presence":{"get":{"tags":["Presence"],"summary":"Get Call Queue Presence","description":"Returns presence status of the call queue members.","operationId":"readCallQueuePresence","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"groupId","in":"path","description":"Internal identifier of an call queue extension","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Extension full name"},"extensionNumber":{"type":"string","description":"Extension number"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"}},"description":"Call queue member information"},"acceptQueueCalls":{"type":"boolean","description":"Private member telephony availability status applied to calls of all queues"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability in this particular queue"}}}}}}}}}},"x-api-group":"call-queues/presence","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadPresence","x-docs-level":"Public","x-feature":"ReadPresenceStatus","x-error-codes":null},"put":{"tags":["Presence"],"summary":"Update Call Queue Presence","description":"Updates presence status of the call queue members in the specified queue.","operationId":"updateCallQueuePresence","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"groupId","in":"path","description":"Internal identifier of a call queue extension","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension - queue member"}},"description":"Call queue member information"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability for calls of this queue"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Extension full name"},"extensionNumber":{"type":"string","description":"Extension number"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Site extension identifier"},"name":{"type":"string","description":"Site extension name"}},"description":"Extension site"}},"description":"Call queue member information"},"acceptQueueCalls":{"type":"boolean","description":"Private member telephony availability status applied to calls of all queues"},"acceptCurrentQueueCalls":{"type":"boolean","description":"Call queue member availability in this particular queue"}}}}}}}}}},"x-api-group":"call-queues/presence","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditPresence","x-docs-level":"Public","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Agent extension ID"},"callQueueId":{"type":"string","description":"Call queue extension ID"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}},"description":"Notification payload body"}}}],"x-codegen-request-body-name":"body","x-feature":"EditPresenceStatus","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-queue-presence":{"get":{"tags":["Presence"],"summary":"Get Agent’s Call Queue Presence","description":"Returns a list of agent's call queues with the agent presence status (per queue)","operationId":"readExtensionCallQueuePresence","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension","required":true,"schema":{"type":"string","default":"~"}},{"name":"editableMemberStatus","in":"query","description":"Filtering by the flag 'Allow members to change their Queue Status'. If 'true' only queues where user can change his availability status are returned","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}}}}}}}}},"x-api-group":"extension/call-queue-presence","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadPresence","x-docs-level":"Public","x-feature":"ReadPresenceStatus","x-error-codes":null},"put":{"tags":["Presence"],"summary":"Update Call Queue Presence","description":"Updates availability of the agent for the call queues.","operationId":"updateExtensionCallQueuePresence","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"callQueue":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}}}}}}}}}},"x-api-group":"extension/call-queue-presence","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditPresence","x-docs-level":"Public","x-feature":"EditPresenceStatus","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Agent extension ID"},"callQueueId":{"type":"string","description":"Call queue extension ID"},"acceptCalls":{"type":"boolean","description":"Call queue agent availability for calls of this queue"}},"description":"Notification payload body"}}}],"x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/glip/chats":{"get":{"tags":["Chats"],"summary":"Get Chats","description":"Returns the list of chats where the user is a member and also public teams that can be joined. All records in response are sorted by creation time of a chat in ascending order.","operationId":"listGlipChats","parameters":[{"name":"type","in":"query","description":"Type of chats to be fetched. By default all type of chats will be fetched","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Everyone","Group","Personal","Direct","Team"]}}},{"name":"recordCount","in":"query","description":"Number of chats to be fetched by one request. The maximum value is 250, by default - 30.","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}}},"x-api-group":"glip/chats","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats","x-rewrite-uri-to":"/glip/v1/chats","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/chats?recordCount=3&type=Team\n","response":"HTTP 200 OK\n\n {\n \"records\": [\n {\n \"id\": \"737286\",\n \"name\": \"Team #1\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2013-04-05T01:06:57.393Z\",\n \"lastModifiedTime\": \"2018-11-01T20:49:13.332Z\"\n },\n {\n \"id\": \"1040390\",\n \"name\": \"Team #2\",\n \"type\": \"Team\",\n \"status\": \"Archived\",\n \"public\": true,\n \"creationTime\": \"2013-04-23T14:49:54.049Z\",\n \"lastModifiedTime\": \"2018-11-01T20:49:14.381Z\"\n },\n {\n \"id\": \"4521990\",\n \"name\": \"Team #3\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2013-07-12T15:14:57.406Z\",\n \"lastModifiedTime\": \"2018-12-10T09:25:06.380Z\"\n }\n ],\n \"navigation\": {\n \"prevPageToken\": \"H4sIAAAAAAACAx2KsQ6DIBQA/+VmBhSq4X2HG2EgigmJ2kaoSWP897YuN9zdyYE0inpzQU7yhNhH2zinFUdc3unXTG8622rXW91dijLdf5kRxj3Fmp/bkNeEYh8Ro5gL4j318/rLvKE8Q4orIYTrC5Kpua12AAAA\"\n }\n}\n\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/glip/chats/{chatId}":{"get":{"tags":["Chats"],"summary":"Get Chat","description":"Returns information about a chat by ID.","operationId":"readGlipChat","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat. If tilda (~) is specified, then `/me` (Personal) chat will be returned","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}}},"404":{"description":"Chat Not Found.","content":{}}},"x-api-group":"glip/chats","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)","x-rewrite-uri-to":"/glip/v1/chats/$1","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/chats/76176056322\n\n","response":"HTTP 200 OK\n\n{\n \"id\": \"76176056322\",\n \"type\": \"Group\",\n \"members\": [\n {\n \"id\": \"986580011\"\n },\n {\n \"id\": \"1337720835\"\n },\n {\n \"id\": \"61307231006\"\n }\n ],\n \"creationTime\": \"2018-03-28T12:54:03.797Z\",\n \"lastModifiedTime\": \"2018-11-02T11:14:29.844Z\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/conversations":{"get":{"tags":["Conversations"],"summary":"Get Conversations","description":"Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a chat in ascending order.","operationId":"listGlipConversations","parameters":[{"name":"recordCount","in":"query","description":"Number of conversations to be fetched by one request. The maximum value is 250, by default - 30","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of conversations","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}}},"x-api-group":"glip/conversations","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/conversations","x-rewrite-uri-to":"/glip/v1/conversations","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/conversations?recordCount=3\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"6090227714\",\n \"type\": \"Personal\",\n \"members\": [\n {\n \"id\": \"61307231006\"\n }\n ],\n \"creationTime\": \"2015-10-06T12:39:43.455Z\",\n \"lastModifiedTime\": \"2018-12-10T08:49:43.035Z\"\n },\n {\n \"id\": \"6090235906\",\n \"type\": \"Direct\",\n \"members\": [\n {\n \"id\": \"986580011\"\n },\n {\n \"id\": \"61307231006\"\n }\n ],\n \"creationTime\": \"2015-10-06T12:39:43.471Z\",\n \"lastModifiedTime\": \"2018-12-10T14:01:34.006Z\"\n },\n {\n \"id\": \"6090244098\",\n \"type\": \"Direct\",\n \"members\": [\n {\n \"id\": \"1337720835\"\n },\n {\n \"id\": \"61307231006\"\n }\n ],\n \"creationTime\": \"2015-10-06T12:40:11.489Z\",\n \"lastModifiedTime\": \"2018-06-15T14:04:48.094Z\"\n }\n ],\n \"navigation\": {\n \"prevPageToken\": \"H4sIAAAAAAACAx2LsQrDIBRF\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]},"post":{"tags":["Conversations"],"summary":"Create/Open Conversation","description":"Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation.","operationId":"createGlipConversation","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"List of glip members. The maximum supported number of IDs is 15. User's own ID is optional. If `members` section is omitted then 'Personal' chat will be returned","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}},"required":true},"responses":{"200":{"description":"Conversation is opened","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}}},"201":{"description":"Conversation is created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/conversations","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/conversations","x-rewrite-uri-to":"/glip/v1/conversations","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/conversations/{chatId}":{"get":{"tags":["Conversations"],"summary":"Get Conversation","description":"Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation.","operationId":"readGlipConversation","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a conversation to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a conversation"},"type":{"type":"string","description":"Type of a conversation","enum":["Direct","Personal","Group"]},"creationTime":{"type":"string","description":"Conversation creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Conversation last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}}},"404":{"description":"Conversation Not Found.","content":{}}},"x-api-group":"glip/conversations","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/conversations/(.*)","x-rewrite-uri-to":"/glip/v1/conversations/$1","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/conversations/6090260482\n","response":"HTTP 200 OK\n\n{\n \"id\": \"6090260482\",\n \"type\": \"Direct\",\n \"members\": [\n {\n \"id\": \"807894011\"\n },\n {\n \"id\": \"61307231006\"\n }\n ],\n \"creationTime\": \"2015-10-06T12:40:19.582Z\",\n \"lastModifiedTime\": \"2018-09-11T13:19:56.402Z\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/teams":{"get":{"tags":["Teams"],"summary":"Get Teams","description":"Returns the list of teams where the user is a member (both archived and active) combined with a list of public teams that can be joined by the current user. All records in response are sorted by creation time of a chat in ascending order.","operationId":"listGlipTeams","parameters":[{"name":"recordCount","in":"query","description":"Number of teams to be fetched by one request. The maximum value is 250, by default - 30","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of teams","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}}},"x-api-group":"glip/teams","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams","x-rewrite-uri-to":"/glip/v1/teams","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/teams?recordCount=4\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"737286\",\n \"name\": \"Team #1\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2013-04-05T01:06:57.393Z\",\n \"lastModifiedTime\": \"2018-11-01T20:49:13.332Z\"\n },\n {\n \"id\": \"1040390\",\n \"name\": \"Team #2\",\n \"type\": \"Team\",\n \"status\": \"Archived\",\n \"public\": true,\n \"creationTime\": \"2013-04-23T14:49:54.049Z\",\n \"lastModifiedTime\": \"2018-11-01T20:49:14.381Z\"\n },\n {\n \"id\": \"4521990\",\n \"name\": \"Team #3\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2013-07-12T15:14:57.406Z\",\n \"lastModifiedTime\": \"2018-12-10T21:10:46.736Z\"\n },\n {\n \"id\": \"232079366\",\n \"name\": \"Team #4\",\n \"description\": \"Description text\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2014-05-15T05:23:08.887Z\",\n \"lastModifiedTime\": \"2018-12-06T21:59:07.786Z\"\n }\n ],\n \"navigation\": {\n \"prevPageToken\": \"H4sIAAAAAAACAx2LQQqDMBQF7zLrv0iMaPvP4S5kIRohoLaYVCji3Wt9i1nM8A521A\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]},"post":{"tags":["Teams"],"summary":"Create Team","description":"Creates a team, and adds a list of people to the team.","operationId":"createGlipTeam","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"public":{"type":"boolean","description":"Team access level."},"name":{"type":"string","description":"Team name."},"description":{"type":"string","description":"Team description."},"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}}}}},"400":{"description":"One of body parameters has invalid value.","content":{}}},"x-api-group":"glip/teams","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams","x-rewrite-uri-to":"/glip/v1/teams","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}":{"get":{"tags":["Teams"],"summary":"Get Team","description":"Returns information about the specified team.","operationId":"readGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}}}}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)","x-rewrite-uri-to":"/glip/v1/teams/$1","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/teams/232087558\n","response":"HTTP 200 OK\n\n{\n \"id\": \"232087558\",\n \"name\": \"Team #1\",\n \"type\": \"Team\",\n \"status\": \"Active\",\n \"public\": true,\n \"creationTime\": \"2014-05-15T05:23:08.892Z\",\n \"lastModifiedTime\": \"2018-09-14T14:33:25.247Z\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-165","message":"null"}]},"delete":{"tags":["Teams"],"summary":"Delete Team","description":"Deletes the specified team.","operationId":"deleteGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content.","content":{}},"403":{"description":"User is not Team Admin.","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)","x-rewrite-uri-to":"/glip/v1/teams/$1","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null},"patch":{"tags":["Teams"],"summary":"Update Team","description":"Updates the name and description of the specified team.","operationId":"patchGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name. Maximum number of characters supported is 250"},"description":{"type":"string","description":"Team description. Maximum number of characters supported is 1000"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a team"},"type":{"type":"string","description":"Type of a chat","enum":["Team"]},"public":{"type":"boolean","description":"Team access level"},"name":{"type":"string","description":"Team name"},"description":{"type":"string","description":"Team description"},"status":{"type":"string","description":"Team status","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Team creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Team last change datetime in ISO 8601 format","format":"date-time"}}}}}},"400":{"description":"One of body parameters has invalid value.","content":{}},"403":{"description":"User is not Team Admin or Team is not active.","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)","x-rewrite-uri-to":"/glip/v1/teams/$1","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}/join":{"post":{"tags":["Teams"],"summary":"Join Team","description":"Adds the current user to the specified team.","operationId":"joinGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be joined.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"205":{"description":"Reset Content","content":{}},"403":{"description":"Team status is not Active or Team is not public","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams/join","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/join","x-rewrite-uri-to":"/glip/v1/teams/$1/join","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}/leave":{"post":{"tags":["Teams"],"summary":"Leave Team","description":"Removes the current user from the specified team.","operationId":"leaveGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be left.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"205":{"description":"Reset Content.","content":{}},"403":{"description":"Team status is not Active.","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams/leave","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/leave","x-rewrite-uri-to":"/glip/v1/teams/$1/leave","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}/add":{"post":{"tags":["Teams"],"summary":"Add Team Members","description":"Adds members to the specified team.","operationId":"addGlipTeamMembers","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to add members to.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"List of glip members","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"email":{"type":"string","description":"Email of a user"}}}}}}}},"required":true},"responses":{"204":{"description":"No Content.","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"User is not Team Admin.","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams/add-members","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/add","x-rewrite-uri-to":"/glip/v1/teams/$1/add","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":[{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/teams/{chatId}/remove":{"post":{"tags":["Teams"],"summary":"Remove Team Members","description":"Removes members from the specified team.","operationId":"removeGlipTeamMembers","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to remove members from.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"required":["members"],"type":"object","properties":{"members":{"type":"array","description":"Identifier(s) of chat members.","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}},"required":true},"responses":{"204":{"description":"No Content.","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"User is not Team Admin.","content":{}},"404":{"description":"Team Not Found.","content":{}}},"x-api-group":"glip/teams/remove-members","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/remove","x-rewrite-uri-to":"/glip/v1/teams/$1/remove","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}/archive":{"post":{"tags":["Teams"],"summary":"Archive Team","description":"Changes the status of the specified team to 'Archived'.","operationId":"archiveGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be archived.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"205":{"description":"Reset Content","content":{}},"403":{"description":"User is not Team Admin","content":{}},"404":{"description":"Team Not Found","content":{}}},"x-api-group":"glip/teams/archive","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/archive","x-rewrite-uri-to":"/glip/v1/teams/$1/archive","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/teams/{chatId}/unarchive":{"post":{"tags":["Teams"],"summary":"Unarchive Team","description":"Changes the status of the specified team to 'Active'.","operationId":"unarchiveGlipTeam","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a team to be made active.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"205":{"description":"Reset Content","content":{}},"403":{"description":"User is not Team Admin","content":{}},"404":{"description":"Team Not Found","content":{}}},"x-api-group":"glip/teams/unarchive","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/teams/(.*)/unarchive","x-rewrite-uri-to":"/glip/v1/teams/$1/unarchive","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/everyone":{"get":{"tags":["Teams"],"summary":"Get Everyone Chat","description":"Returns information about Everyone chat.","operationId":"readGlipEveryone","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone"]},"name":{"type":"string","description":"Chat name"},"description":{"type":"string","description":"Chat description"},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"}}}}}},"404":{"description":"Chat Not Found.","content":{}}},"x-api-group":"glip/everyone","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/everyone","x-rewrite-uri-to":"/glip/v1/everyone","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/everyone\n","response":"HTTP 200 OK\n\n{\n \"id\": \"52342\",\n \"creationTime\": \"2015-03-31T16:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Everyone\",\n \"name\": \"All Company\",\n \"description\": \"All employees\"\n}\n"}],"x-error-codes":null},"patch":{"tags":["Teams"],"summary":"Update Everyone Сhat","description":"Updates Everyone chat information.","operationId":"patchGlipEveryone","requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"type":"object","properties":{"name":{"type":"integer","description":"Everyone chat name. Maximum number of characters supported is 250"},"description":{"type":"string","description":"Everyone chat description. Maximum number of characters supported is 1000"}}}}},"required":false},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone"]},"name":{"type":"string","description":"Chat name"},"description":{"type":"string","description":"Chat description"},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"}}}}}},"404":{"description":"Chat Not Found.","content":{}}},"x-api-group":"glip/everyone","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/everyone","x-rewrite-uri-to":"/glip/v1/everyone","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"PATCH /restapi/v1.0/glip/everyone\n\n{\n\n \"name\" : \"Chat name\",\n \"description\": \"Chat description\"\n}\n\n","response":"HTTP 200 OK\n\n{\n \"id\": \"52342\",\n \"creationTime\": \"2015-03-31T16:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Everyone\",\n \"name\" : \"Chat name\",\n \"description\": \"Chat description\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/recent/chats":{"get":{"tags":["Chats"],"summary":"Get Recent Chats","description":"Returns recent chats where the user is a member. All records in response are sorted by the `lastModifiedTime` in descending order (the latest changed chat is displayed first on page)","operationId":"listRecentChats","parameters":[{"name":"type","in":"query","description":"Type of chats to be fetched. By default all chat types are returned","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Everyone","Group","Personal","Direct","Team"]}}},{"name":"recordCount","in":"query","description":"Max number of chats to be fetched by one request (Not more than 250).","schema":{"maximum":250,"type":"integer","default":30}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/recent","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/recent/chats","x-rewrite-uri-to":"/glip/v1/recent/chats","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/favorites":{"get":{"tags":["Chats"],"summary":"Get Favorite Chats","description":"Returns a list of the current user's favorite chats.","operationId":"listFavoriteChats","parameters":[{"name":"recordCount","in":"query","description":"Max number of chats to be fetched by one request (Not more than 250).","schema":{"maximum":250,"type":"integer","default":30}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a chat"},"type":{"type":"string","description":"Type of a chat","enum":["Everyone","Team","Group","Direct","Personal"]},"public":{"type":"boolean","description":"For 'Team' chat type only. Team access level."},"name":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat name."},"description":{"type":"string","description":"For 'Team','Everyone' chats types only. Chat description."},"status":{"type":"string","description":"For 'Team' chat type only. Team status.","enum":["Active","Archived"]},"creationTime":{"type":"string","description":"Chat creation datetime in ISO 8601 format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Chat last change datetime in ISO 8601 format","format":"date-time"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/favorites","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/favorites","x-rewrite-uri-to":"/glip/v1/favorites","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/favorite":{"post":{"tags":["Chats"],"summary":"Add Chat to Favorites","description":"Adds the specified chat to the users's list of favorites.","operationId":"favoriteGlipChat","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat to add to favorite list.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Favorite chat list is limited to 250 unique chats","content":{}},"403":{"description":"User is not member of chat","content":{}},"404":{"description":"Chat not found","content":{}}},"x-api-group":"glip/chats/favorite","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/favorite","x-rewrite-uri-to":"/glip/v1/chats/$1/favorite","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/unfavorite":{"post":{"tags":["Chats"],"summary":"Remove Chat from Favorites","description":"Removes the specified chat from the users's list of favorites.","operationId":"unfavoriteGlipChat","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat to remove from favorite list.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"404":{"description":"Chat not found","content":{}}},"x-api-group":"glip/chats/unfavorite","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/unfavorite","x-rewrite-uri-to":"/glip/v1/chats/$1/unfavorite","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/read":{"post":{"tags":["Chats"],"summary":"Mark Chat as Read","description":"Sets the specified chat status to 'Read' for the current user.","operationId":"markChatRead","parameters":[{"name":"chatId","in":"path","description":"Id of chat to be marked","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"204":{"description":"No Content","content":{}},"403":{"description":"You have no permissions to mark this chat","content":{}},"404":{"description":"Chat is not found","content":{}}},"x-api-group":"glip/glpum","x-metered-api":true,"x-metering-group":"System","x-app-permission":"GlipInternal","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/([0-9]+)/read","x-rewrite-uri-to":"/glip/v1/chats/$1/read","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/unread":{"post":{"tags":["Chats"],"summary":"Mark Chat as Unread","description":"Sets the specified chat status to 'Unread' for the current user.","operationId":"markChatUnread","parameters":[{"name":"chatId","in":"path","description":"Id of chat to be marked","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"204":{"description":"No Content","content":{}},"403":{"description":"You have no permissions to mark this chat","content":{}},"404":{"description":"Chat is not found","content":{}}},"x-api-group":"glip/glpum","x-metered-api":true,"x-metering-group":"System","x-app-permission":"GlipInternal","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/([0-9]+)/unread","x-rewrite-uri-to":"/glip/v1/chats/$1/unread","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"}]}},"/restapi/v1.0/glip/chats/{chatId}/posts/{postId}":{"get":{"tags":["Posts"],"summary":"Get Post","description":"Returns information about the specified post.","operationId":"readGlipPost","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat.","required":true,"schema":{"type":"string"}},{"name":"postId","in":"path","description":"Internal identifier of a post.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}}}},"404":{"description":"Post Not Found.","content":{}}},"x-api-group":"glip/chats/posts","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/posts/(.*)","x-rewrite-uri-to":"/glip/v1/chats/$1/posts/$2","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/posts/4604853739524\n","response":"HTTP 200 OK\n\n{\n \"id\": \"4604853739524\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": null,\n \"creatorId\": \"1337720835\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-07T09:11:51.457Z\",\n \"lastModifiedTime\": \"2018-06-07T09:11:51.457Z\",\n \"attachments\": [\n {\n \"id\": \"161429274634\",\n \"name\": \"image.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/525446815756/image.png?Expires=2075494478&AWSAccessKeyId=AKIAJROPQDFTIHBTLJJQ&Signature=4otw69tTsg7KWubelyME%2F8ChUkU%3D\",\n \"type\": \"File\"\n }\n ],\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n}\n"}],"x-error-codes":null},"delete":{"tags":["Posts"],"summary":"Delete Post","description":"Deletes the specified post from the chat.","operationId":"deleteGlipPost","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat.","required":true,"schema":{"type":"string"}},{"name":"postId","in":"path","description":"Internal identifier of a post to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content.","content":{}},"403":{"description":"Requestor has no permissions to do this action.","content":{}},"404":{"description":"Post Not Found.","content":{}}},"x-api-group":"glip/chats/posts","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/posts/(.*)","x-rewrite-uri-to":"/glip/v1/chats/$1/posts/$2","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]},"patch":{"tags":["Posts"],"summary":"Update Post","description":"Updates a specific post within a chat.","operationId":"patchGlipPost","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat.","required":true,"schema":{"type":"string"}},{"name":"postId","in":"path","description":"Internal identifier of a post to be updated.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Post text."}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}}}},"400":{"description":"One of body parameters has invalid value.","content":{}},"403":{"description":"Requestor has no permissions to do this action.","content":{}},"404":{"description":"Chat not found.","content":{}}},"x-api-group":"glip/chats/posts","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/posts/(.*)","x-rewrite-uri-to":"/glip/v1/chats/$1/posts/$2","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/posts":{"get":{"tags":["Posts"],"summary":"Get Posts","description":"Returns a list of posts from the specified chat.","operationId":"readGlipPosts","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat","required":true,"schema":{"type":"string"}},{"name":"recordCount","in":"query","description":"Max number of posts to be fetched by one request (not more than 250)","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of posts","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}}},"x-api-group":"glip/chats/posts","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/posts/?","x-rewrite-uri-to":"/glip/v1/chats/$1/posts","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null},"post":{"tags":["Posts"],"summary":"Create Post","description":"Creates a post in the chat specified in path. Any mention can be added within the `text` attribute of the request body in .md format - [![:Type](id)], where `type` is one of (Person, Team, File, Note, Task, Event, Link, Card) and `id` is a unique identifier of the mentioned object of the specified type. Attachments of the following types (File, Card, Event, Note) can also be added to a post by passing type and ID of attachment(s) in request body.","operationId":"createGlipPost","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","description":"Post data. At least one attribute should be provided (text or attachments)","properties":{"text":{"type":"string","description":"Text of a post. Maximum length is 10000 symbols. Mentions can be added in .md format [![:Type](id)]"},"attachments":{"type":"array","description":"Identifier(s) of attachments. Maximum number of attachments is 25","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}}}},"required":true},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}}}},"400":{"description":"One of body parameters has invalid value.","content":{}},"404":{"description":"Resource for parameter [chatId] is not found.","content":{}}},"x-api-group":"glip/chats/posts","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/posts/?","x-rewrite-uri-to":"/glip/v1/chats/$1/posts","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"POST /glip/chats/v1/{chatId}/posts\n\n{\n \"text\": \"Hello World, ![:Team](2096603144) ![:Person](glip-3770114054) \",\n \"attachments\": [{\n \"id\": \"233743409164\",\n \"type\": \"File\"\n }]\n}\n\n","response":"HTTP/1.1 201 Created\n\n{\n \"id\": \"6401972207624\",\n \"type\": \"TextMessage\",\n \"groupId\": \"5076123654\",\n \"chatId\": \"5076123654\",\n \"text\": \"Hello World ![:Team](2096603144) ![:Person](glip-3770114054) \",\n \"creatorId\": \"256744024\",\n \"creationTime\": \"2018-11-07T16:10:21.723Z\",\n \"lastModifiedTime\": \"2018-11-07T16:10:21.723Z\",\n \"attachments\": [{\n \"id\": \"233743409164\",\n \"name\": \"Screenshot 2018-11-07 at 19.01.42.png\",\n \"contentUri\": \"https://glip-vault-1.s3.amazonaws.com/web/customer_files/752637419534/Screenshot%202018-11-07%20at%2019.01.42.png?Expires=2075494478&AWSAccessKeyId=AKIAJROPQDFTIHBTLJJQ&Signature=tdsVOClzesfxAzzOhZTeqIjelXw%3D\",\n \"type\": \"File\"\n }],\n \"mentions\": [{\n \"id\": \"2096603144\",\n \"type\": \"Team\",\n \"name\": \"My Team\"\n }, {\n \"id\": \"glip-3770114054\",\n \"type\": \"Person\",\n \"name\": \"John Smith\"\n }]\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/groups/{groupId}/posts":{"get":{"tags":["Posts"],"summary":"Get Group Posts","description":"Returns posts which are available for the current user by group ID.","operationId":"listGlipGroupPosts","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}},{"name":"recordCount","in":"query","description":"Max number of records to be returned","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of posts","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}},"404":{"description":"Group with specified ID is not found.","content":{}}},"deprecated":true,"x-api-group":"glip/posts","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/posts","x-rewrite-uri-to":"/glip/v1/groups/$1/posts","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-notifications":[{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"eventType":{"type":"string","description":"Type of a post event","enum":["PostAdded","PostChanged","PostRemoved"]},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post. 'TextMessage' - an incoming text message; 'PersonJoined' - a message notifying that person has joined a conversation; 'PersonsAdded' - a message notifying that a person(s) were added to a conversation","enum":["TextMessage","PersonJoined","PersonsAdded","Card"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Message text"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For PersonsAdded post type only. Identifiers of persons added to a group","items":{"type":"string"}},"removedPersonIds":{"type":"array","description":"For PersonsRemoved post type only. Identifiers of persons removed from a group","items":{"type":"string"}},"mentions":{"type":"array","description":"List of at mentions in post text with names.","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}],"x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/groups/76176056322/posts?recordCount=3&pageToken=eyJ2IjoxLCJkIjotMSwidHMiOjE1Mjg4OTQ3NzM1NjIsInJjIjozfQ==\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"4656932454404\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": \"Message #1\",\n \"creatorId\": \"986580011\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-13T12:58:21.025Z\",\n \"lastModifiedTime\": \"2018-06-13T12:58:21.025Z\",\n \"attachments\": null,\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n },\n {\n \"id\": \"4604853739524\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": null,\n \"creatorId\": \"1337720835\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-07T09:11:51.457Z\",\n \"lastModifiedTime\": \"2018-06-07T09:11:51.457Z\",\n \"attachments\": [\n {\n \"id\": \"161429274634\",\n \"name\": \"image.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/525446815756/image.png?Expires=2075494478&AWSAccessKeyId=AKIAJROPQDFTIHBTLJJQ&Signature=4otw69tTsg7KWubelyME%2F8ChUkU%3D\",\n \"type\": \"File\"\n }\n ],\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n },\n {\n \"id\": \"4604844154884\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": \"Message #3\",\n \"creatorId\": \"61307231006\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-07T09:09:25.622Z\",\n \"lastModifiedTime\": \"2018-06-07T09:09:25.622Z\",\n \"attachments\": null,\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n }\n ],\n \"navigation\": {\n \"prevPageToken\": \"eyJ2IjoxLCJkIjotMSwidHMiOjE1MjgzNjI1NjU2MjIsInJjIjozfQ==\",\n \"nextPageToken\": \"eyJ2IjoxLCJkIjoxLCJ0cyI6MTUyODg5NDcwMTAyNSwicmMiOjN9\"\n }\n\n"},{"request":"GET /restapi/v1.0/glip/posts?groupId=76176056322&recordCount=2&pageToken=eyJ2IjoxLCJkIjotMSwidHMiOjE1Mjg4OTQ3NzM1NjIsInJjIjozfQ==\n","response":"HTTP 200 OK\n{\n \"records\": [\n {\n \"id\": \"4656932454404\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": \"Hello, World!\",\n \"creatorId\": \"986580011\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-13T12:58:21.025Z\",\n \"lastModifiedTime\": \"2018-06-13T12:58:21.025Z\",\n \"attachments\": null,\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n },\n {\n \"id\": \"4604853739524\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": null,\n \"creatorId\": \"1337720835\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-06-07T09:11:51.457Z\",\n \"lastModifiedTime\": \"2018-06-07T09:11:51.457Z\",\n \"attachments\": [\n {\n \"id\": \"161429274634\",\n \"name\": \"image.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/525446815756/image.png?Expires=2075494478&AWSAccessKeyId=AKIAJROPQDFTIHBTLJJQ&Signature=4otw69tTsg7KWubelyME%2F8ChUkU%3D\",\n \"type\": \"File\"\n }\n ],\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n }\n ],\n \"navigation\": {\n \"prevPageToken\": \"eyJ2IjoxLCJkIjotMSwidHMiOjE1MjgzNjI3MTE0NTcsInJjIjoyfQ==\",\n \"nextPageToken\": \"eyJ2IjoxLCJkIjoxLCJ0cyI6MTUyODg5NDcwMTAyNSwicmMiOjJ9\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"post":{"tags":["Posts"],"summary":"Create Post in Group","description":"Creates a new post in a group specified.","operationId":"createGlipGroupPost","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"string"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)."},"text":{"type":"string","description":"Text of a post"},"groupId":{"type":"string","description":"Internal identifier of a group"},"attachments":{"type":"array","description":"List of attachments to be posted","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}}},"personIds":{"type":"array","items":{"type":"string"}},"system":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Group not found.","content":{}}},"deprecated":true,"x-api-group":"glip/posts","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/posts","x-rewrite-uri-to":"/glip/v1/groups/$1/posts","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/groups/76176056322/posts\n\n{\n \"text\": \"A new message to a group\" \n}\n\n","response":"HTTP 200 OK\n\n{\n \"id\": \"6932100259844\",\n \"groupId\": \"76176056322\",\n \"type\": \"TextMessage\",\n \"text\": \"A new message to a group\",\n \"creatorId\": \"61307231006\",\n \"addedPersonIds\": null,\n \"creationTime\": \"2018-12-12T11:08:57.866Z\",\n \"lastModifiedTime\": \"2018-12-12T11:08:57.866Z\",\n \"attachments\": null,\n \"activity\": null,\n \"title\": null,\n \"iconUri\": null,\n \"iconEmoji\": null,\n \"mentions\": null\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/groups/{groupId}/posts/{postId}/text":{"put":{"tags":["Posts"],"summary":"Update Post","description":"Modifies text of a post.","operationId":"updateGlipPostText","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}},{"name":"postId","in":"path","description":"Internal identifier of a post","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"text/*":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"Forbidden","content":{}}},"deprecated":true,"x-api-group":"glip/posts","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/posts/([0-9]+)/text","x-rewrite-uri-to":"/glip/v1/groups/$1/posts/$2/text","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-codegen-request-body-name":"text","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"PUT /restapi/v1.0/glip/groups/76176056322/posts/4604785991684/text\n\n{\n \"text\": \"New text of a message\"\n}\n","response":"HTTP 200 OK\n\n{\n \"text\": \"New text of a message\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/cards":{"post":{"tags":["Posts"],"summary":"Create Card","description":"Creates a new message.","operationId":"createGlipCard","parameters":[{"name":"groupId","in":"query","description":"Internal identifier of a group where to create a post with the card","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"deprecated":true,"x-api-group":"glip/cards","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/cards","x-rewrite-uri-to":"/glip/v1/cards","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/cards\n","response":"HTTP 200 OK\n\n{\n \"id\": \"15685050413\",\n \"fallback\": \"\",\n \"intro\": \"Intro text\",\n \"author\": {\n \"name\": \"John Smith\",\n \"uri\": \"https://www.example.com/blog/author/johnsmith/\",\n \"iconUri\": \"https://example.com/author/johnsmith.jpg\"\n },\n \"title\": \"Title\",\n \"text\": \"Text\",\n \"imageUri\": \"https://example.com/image.jpg\",\n \"fields\": [\n {\n \"title\": \"Title #1\",\n \"value\": \"Value #1\",\n \"style\": \"Long\"\n },\n {ß\n \"title\": \"Title #2\",\n \"value\": \"Value #2\",\n \"style\": \"Short\"\n }\n ],\n \"footnote\": {\n \"text\": \"footer text\",\n \"iconUri\": \"https://example.com/iconUri.jpg\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/cards/{cardId}":{"get":{"tags":["Posts"],"summary":"Get Card","description":"Returns card(s) with given id(s).","operationId":"readGlipCard","parameters":[{"name":"cardId","in":"path","description":"Internal identifier of a card or comma separated list of card IDs.","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Card not found.","content":{}}},"deprecated":true,"x-api-group":"glip/cards","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/cards/(.*)","x-rewrite-uri-to":"/glip/v1/cards/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/cards/15685050413\n","response":"HTTP 200 OK\n\n{\n \"id\": \"15685050413\",\n \"fallback\": \"\",\n \"intro\": \"Intro text\",\n \"author\": {\n \"name\": \"John Smith\",\n \"uri\": \"https://www.example.com/blog/author/johnsmith/\",\n \"iconUri\": \"https://example.com/author/johnsmith.jpg\"\n },\n \"title\": \"Title\",\n \"text\": \"Text\",\n \"imageUri\": \"https://example.com/image.jpg\",\n \"fields\": [\n {\n \"title\": \"Title #1\",\n \"value\": \"Value #1\",\n \"style\": \"Long\"\n },\n {\n \"title\": \"Title #2\",\n \"value\": \"Value #2\",\n \"style\": \"Short\"\n }\n ],\n \"footnote\": {\n \"text\": \"footer text\",\n \"iconUri\": \"https://example.com/iconUri.jpg\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]},"put":{"tags":["Posts"],"summary":"Update Card","description":"Updates a card.","operationId":"updateGlipCard","parameters":[{"name":"cardId","in":"path","description":"Internal identifier of a card","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Card for update does not exist.","content":{}}},"deprecated":true,"x-api-group":"glip/cards","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/cards/(.*)","x-rewrite-uri-to":"/glip/v1/cards/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"PUT /restapi/v1.0/glip/cards/15685050413\n{\n \"id\": \"15685050413\",\n \"color\": \"#9C1A22\",\n \"text\": \"New text\",\n \"intro\": \"Intro text\",\n \"author\": {\n \"name\": \"John Smith\",\n \"uri\": \"https://www.example.com/blog/author/johnsmith/\",\n \"iconUri\": \"https://example.com/author/johnsmith.jpg\"\n },\n \"footnote\": {\n \"text\": \"Footer text\"\n },\n \"startTime\":\"2018-03-09T18:07:52.534Z\",\n \"endTime\": \"2018-12-01T18:07:52.534Z\",\n \"recurrence\": \"Week\"\n \n}\n\n","response":"HTTP 200 OK\n\n{\n \"id\": \"15685050413\",\n \"fallback\": \"\",\n \"color\": \"#9C1A22\",\n \"intro\": \"Intro text\",\n \"author\": {\n \"name\": \"John Smith\",\n \"uri\": \"https://www.example.com/blog/author/johnsmith/\",\n \"iconUri\": \"https://example.com/author/johnsmith.jpg\"\n },\n \"text\": \"New text\",\n \"footnote\": {\n \"text\": \"Footer text\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]},"delete":{"tags":["Posts"],"summary":"Delete Card","description":"Deletes a card by ID.","operationId":"deleteGlipCard","parameters":[{"name":"cardId","in":"path","description":"Card ID to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Card not found.","content":{}}},"deprecated":true,"x-api-group":"glip/cards","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/cards/(.*)","x-rewrite-uri-to":"/glip/v1/cards/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/glip/cards/15685050413\n","response":"HTTP 200 OK\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/events":{"get":{"tags":["Calendar Events"],"summary":"Get User Events List","description":"Returns all calendar events created by the current user.","operationId":"readGlipEvents","parameters":[{"name":"recordCount","in":"query","description":"Number of groups to be fetched by one request. The maximum value is 250, by default - 30.","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Token of a page to be returned","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of events created by the current user","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of events created by the current user","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/events","x-rewrite-uri-to":"/glip/v1/events","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/events?recordCount=&pageToken=eyJ2IjoxLCJkIjotMSwidHMiOjE1NDExNjgwNjkzMTYsInJjIjoyfQ\n","response":"HTTP 200 OK\n{\n \"records\": [\n {\n \"id\": \"12470697998\",\n \"type\": \"Event\",\n \"creatorId\": \"61307231006\",\n \"title\": \"Event #1\",\n \"startTime\": \"2018-11-05T13:00:00Z\",\n \"endTime\": \"2018-11-05T15:00:00Z\",\n \"recurrence\": \"None\",\n \"endingCondition\": \"None\",\n \"color\": \"Green\",\n \"allDay\": false\n },\n {\n \"id\": \"12470722574\",\n \"type\": \"Event\",\n \"creatorId\": \"61307231006\",\n \"title\": \"Event #2\",\n \"startTime\": \"2018-11-05T13:00:00Z\",\n \"endTime\": \"2018-11-05T15:00:00Z\",\n \"recurrence\": \"None\",\n \"endingCondition\": \"None\",\n \"color\": \"Blue\",\n \"allDay\": false\n }\n ],\n \"navigation\": {\n \"nextPageToken\": \"eyJ2IjoxLCJkIjoxLCJ0cyI6MTU0MTE2ODAwMDIxOSwicmMiOjJ9\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]},"post":{"tags":["Calendar Events"],"summary":"Create Event","description":"Creates a new calendar event.","operationId":"createEvent","requestBody":{"content":{"application/json":{"schema":{"required":["endTime","startTime","title"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether event has some specific time slot or lasts for whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count'"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events.","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/events","x-rewrite-uri-to":"/glip/v1/events","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/groups/76176056322/events\n{\n \"title\": \"Siesta\",\n \"startTime\": \"2018-11-05T13:00:00Z\",\n \"endTime\": \"2018-11-05T15:00:00Z\",\n \"color\": \"Green\",\n \"period\": \"Day\"\n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12470755342\",\n \"type\": \"Event\",\n \"creatorId\": \"61307231006\",\n \"title\": \"Siesta\",\n \"startTime\": \"2018-11-05T13:00:00Z\",\n \"endTime\": \"2018-11-05T15:00:00Z\",\n \"recurrence\": \"None\",\n \"endingCondition\": \"None\",\n \"color\": \"Green\",\n \"allDay\": false\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/events/{eventId}":{"get":{"tags":["Calendar Events"],"summary":"Get Event","description":"Returns the specified calendar event(s) by ID(s).","operationId":"readEvent","parameters":[{"name":"eventId","in":"path","description":"event id or comma separated list of event ids.","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Event not found.","content":{}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/events/(.*)","x-rewrite-uri-to":"/glip/v1/events/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/events/12470697998\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12470697998\",\n \"type\": \"Event\",\n \"creatorId\": \"61307231006\",\n \"title\": \"Event #1\",\n \"startTime\": \"2018-11-05T13:00:00Z\",\n \"endTime\": \"2018-11-05T15:00:00Z\",\n \"recurrence\": \"None\",\n \"endingCondition\": \"None\",\n \"color\": \"Green\",\n \"allDay\": false\n}\n\n"}],"x-error-codes":null},"put":{"tags":["Calendar Events"],"summary":"Update Event","description":"Updates the specified calendar event.","operationId":"updateEvent","parameters":[{"name":"eventId","in":"path","description":"Internal identifier of an event","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["endTime","startTime","title"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether event has some specific time slot or lasts for whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count'"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events.","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Event to update not exists.","content":{}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/events/(.*)","x-rewrite-uri-to":"/glip/v1/events/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"PUT /restapi/v1.0/glip/events/12963512334\n\n{\n \"title\": \"Meeting #1\",\n \"location\": \"San-Francisco, CA\",\n \"startTime\": \"2019-01-01T13:00:00Z\",\n \"endTime\": \"2019-05-05T13:00:00Z\",\n \"color\": \"Blue\"\n \n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12963512334\",\n \"type\": \"Event\",\n \"creatorId\": \"61307231006\",\n \"title\": \"Meeting #1\",\n \"location\": \"San-Francisco, CA\",\n \"startTime\": \"2019-05-05T13:00:00Z\",\n \"endTime\": \"2019-05-05T15:00:00Z\",\n \"recurrence\": \"None\",\n \"endingCondition\": \"None\",\n \"color\": \"Blue\",\n \"allDay\": false\n}\n\n"}],"x-error-codes":null},"delete":{"tags":["Calendar Events"],"summary":"Delete Event","description":"Deletes the specified calendar event.","operationId":"deleteEvent","parameters":[{"name":"eventId","in":"path","description":"Internal identifier of an event to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Event not found.","content":{}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/events/(.*)","x-rewrite-uri-to":"/glip/v1/events/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/glip/events/12470722574\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/groups/{groupId}/events":{"get":{"tags":["Calendar Events"],"summary":"Get Group Events","description":"Returns a list of calendar events available for the current user within the specified group. Users can only see their personal tasks and public tasks.","operationId":"listGroupEvents","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"404":{"description":"Group with specified Id is not found.","content":{}}},"x-api-group":"glip/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/events","x-rewrite-uri-to":"/glip/v1/groups/$1/events","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null},"post":{"tags":["Calendar Events"],"summary":"Create Event by Group ID","description":"Creates a new calendar event within the specified group.","operationId":"createEventbyGroupId","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["endTime","startTime","title"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether event has some specific time slot or lasts for whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count'"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events.","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an event"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"title":{"type":"string","description":"Event title"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title (including its presentation in Calendar)","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/groups/events","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/events","x-rewrite-uri-to":"/glip/v1/groups/$1/events","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/notes":{"get":{"tags":["Notes"],"summary":"Get Chat Notes","description":"Returns the list of notes created in the specified chat.","operationId":"listChatNotes","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat to fetch notes from.","required":true,"schema":{"type":"string"}},{"name":"creationTimeTo","in":"query","description":"The end datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, e.g. 2019-03-10T18:23:45. The default value is Now.","schema":{"type":"string"}},{"name":"creationTimeFrom","in":"query","description":"The start datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone","schema":{"type":"string"}},{"name":"creatorId","in":"query","description":"Internal identifier of the user that created the note. Multiple values are supported","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status of notes to be fetched; if not specified all notes are fetched by default.","schema":{"type":"string","enum":["Active","Draft"]}},{"name":"pageToken","in":"query","description":"Pagination token","schema":{"type":"string"}},{"name":"recordCount","in":"query","description":"Max number of notes to be fetched by one request; the value range is 1-250.","schema":{"maximum":250,"type":"integer","default":30}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"You do not have permissions to get such kind of information.","content":{}},"404":{"description":"Group Not Found.","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Heavy","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/([0-9]+)/notes","x-rewrite-uri-to":"/glip/v1/chats/$1/notes","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null},"post":{"tags":["Notes"],"summary":"Create Note","description":"Creates a new note in the specified chat.","operationId":"createChatNote","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat to create a note in","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Title of a note. Max allowed legth is 250 characters"},"body":{"type":"string","description":"Contents of a note; HTML-markuped text. Max allowed length is 1048576 characters (1 Mb)."}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"You do not have permissions to create note in the specified group.","content":{}},"404":{"description":"Group not found.","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/([0-9]+)/notes","x-rewrite-uri-to":"/glip/v1/chats/$1/notes","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/chats/52342/notes\n\n{\n \"title\": \"Note title\",\n \"body\": \"Text of a note\"\n}\n``` \n\n### Response\n```HTTP\nHTTP 201 Created\n\n{\n \"id\": \"note123\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-07T12:35:93\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"lastModifiedBy\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\"],\n \"status\": \"Draft\",\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\"\n}\n","response":""},{"request":"GET /restapi/v1.0/glip/chats/52342/notes?recordCount=2\n\n","response":"HTTP 200 OK\n\n{\n \"records\": [{\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"lastModifiedBy\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"status\": \"Draft\",\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\"\n }, {\n \"id\": \"not123\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T17:24:34\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"lastModifiedBy\": {\"id\": \"6634\"},\n \"lockedBy\": {\"id\": \"42311\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"status\": \"Active\",\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\"\n }],\n \"navigation\": {\n \"nextPageToken\": \"62hdfjhq87xjh\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]}},"/restapi/v1.0/glip/notes/{noteId}":{"get":{"tags":["Notes"],"summary":"Get Note","description":"Returns the specified note(s). It is possible to fetch up to 50 notes per request.","operationId":"readUserNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be fetched","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"body":{"type":"string","description":"Text of a note"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}}}}},"404":{"description":"When note is not found.","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/(.*)","x-rewrite-uri-to":"/glip/v1/notes/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"title":"Single Note","request":"GET /restapi/v1.0/glip/notes/546372\n","response":"HTTP 200 OK\n\n{\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\",\n \"body\": \"Text of a note\",\n \"status\": \"Draft\",\n \"lastModifiedBy\": {\"id\": \"con987\"}\n}\n\n"},{"title":"Multiple Notes","request":"GET /restapi/v1.0/glip/notes/546372,109238,note123\n","response":"HTTP/1.1 207 Multi-status\nContent-Type: application/json\n\n[\n {\n \"status\": 200,\n \"resourceId\": \"546372\",\n \"body\": {\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\",\n \"body\": \"Text of a note\",\n \"status\": \"Draft\",\n \"lastModifiedBy\": {\"id\": \"con987\"}\n }\n }, {\n \"status\": 404,\n \"resourceId\": \"109238\",\n \"body\": {\n \"errors\": [{\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [noteId] is not found.\",\n \"parameterName\": \"noteId\"\n }]\n }\n }, {\n \"status\": 200,\n \"headers\": [ ... ],\n \"resourceId\": \"note123\",\n \"body\": {\n \"id\": \"note123\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T17:24:34\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"title\": \"Note title\",\n \"preview\": \"Note preview text\",\n \"body\": \"Text of a note\",\n \"status\": \"Active\",\n \"lastModifiedBy\": {\"id\": \"6634\"}\n \"lockedBy\": {\"id\": \"42311\"}\n }\n }\n]\n\n"}],"x-error-codes":null},"delete":{"tags":["Notes"],"summary":"Delete Note","description":"Deletes the specified note.","operationId":"deleteNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be deleted","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Note is locked by another user","content":{}},"403":{"description":"You have no permissions to delete note","content":{}},"404":{"description":"Note is not found","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/(.*)","x-rewrite-uri-to":"/glip/v1/notes/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/glip/notes/4152688658\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null},"patch":{"tags":["Notes"],"summary":"Update Note","description":"Edits a note. Notes can be edited by any user if posted to a chat the user belongs to.","operationId":"patchNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be updated","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Title of a note. Max allowed legth is 250 characters"},"body":{"type":"string","description":"Contents of a note; HTML-markuped text. Max allowed length is 1048576 characters (1 Mb)."}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a note"},"title":{"type":"string","description":"Title of a note"},"chatIds":{"type":"array","description":"Internal identifiers of the chat(s) where the note is posted or shared.","items":{"type":"string"}},"preview":{"type":"string","description":"Preview of a note (first 150 characters of a body)"},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"lastModifiedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user who last updated the note"}},"description":"Note last modification information"},"lockedBy":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the user editing the note"}},"description":"Returned for the note being edited (locked) at the current moment. Information on the user editing the note"},"status":{"type":"string","description":"Note publishing status. Any note is created in 'Draft' status. After it is posted it becomes 'Active'","enum":["Active","Draft"]},"creationTime":{"type":"string","description":"Creation time"},"lastModifiedTime":{"type":"string","description":"Datetime of the note last update"},"type":{"type":"string","enum":["Note"]}}}}}},"400":{"description":"Note is locked by another user","content":{}},"403":{"description":"You have no permissions to update the note","content":{}},"404":{"description":"Note is not found","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/([0-9]+)","x-rewrite-uri-to":"/glip/v1/notes/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"PATCH /restapi/v1.0/glip/notes/note123\n\n{\n \"title\": \"Updated note title\"\n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"note123\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T22:12:31\",\n \"type\": \"Note\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\", \"937265\"],\n \"title\": \"Updated note title\",\n \"preview\": \"Note preview text\",\n \"status\": \"Active\",\n \"lastModifiedBy\": {\"id\": \"72364\"}\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/notes/{noteId}/lock":{"post":{"tags":["Notes"],"summary":"Lock Note","description":"Locks a note providing the user with the unique write access for 5 hours.","operationId":"lockNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be locked","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Сontent","content":{}},"400":{"description":"Note is locked by another user","content":{}},"403":{"description":"You have no permissions to lock the note","content":{}},"404":{"description":"Note is not found","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Light","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/([0-9]+)/lock","x-rewrite-uri-to":"/glip/v1/notes/$1/lock","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/notes/4156186642/lock\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/notes/{noteId}/unlock":{"post":{"tags":["Notes"],"summary":"Unlock Note","description":"Unlocks a note letting other users edit this note. Once the note is locked (by another user) it cannot be unlocked during 5 hours since the lock datetime.","operationId":"unlockNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be unlocked","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Note is locked by another user","content":{}},"403":{"description":"You have no permissions to unlock the note","content":{}},"404":{"description":"Note is not found","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Light","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/([0-9]+)/unlock","x-rewrite-uri-to":"/glip/v1/notes/$1/unlock","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/notes/4156186642/unlock\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/notes/{noteId}/publish":{"post":{"tags":["Notes"],"summary":"Publish Note","description":"Publishes a note making it visible to other users.","operationId":"publishNote","parameters":[{"name":"noteId","in":"path","description":"Internal identifier of a note to be published","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"User is not a creator of note","content":{}},"404":{"description":"Note is not found","content":{}}},"x-api-group":"glip/notes","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/notes/([0-9]+)/publish","x-rewrite-uri-to":"/glip/v1/notes/$1/publish","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/notes/4149821458/publish\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/chats/{chatId}/tasks":{"get":{"tags":["Tasks"],"summary":"Get Chat Tasks","description":"Returns the list of tasks of the specified chat.","operationId":"listChatTasks","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat","required":true,"schema":{"type":"string"}},{"name":"creationTimeTo","in":"query","description":"The end datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, e.g. 2019-03-10T18:23:45Z","schema":{"type":"string","default":"now"}},{"name":"creationTimeFrom","in":"query","description":"The start datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, e.g. 2016-02-23T00:00:00","schema":{"type":"string"}},{"name":"creatorId","in":"query","description":"Internal identifier of a task creator","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"status","in":"query","description":"Task execution status","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["Pending","InProgress","Completed"]}}},{"name":"assignmentStatus","in":"query","description":"Task assignment status","schema":{"type":"string","enum":["Unassigned","Assigned"]}},{"name":"assigneeId","in":"query","description":"Internal identifier of a task assignee","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"assigneeStatus","in":"query","description":"Task execution status by assignee(-s) specified in assigneeId","schema":{"type":"string","enum":["Pending","Completed"]}},{"name":"pageToken","in":"query","description":"Token of the current page. If token is omitted then the first page should be returned","schema":{"type":"string"}},{"name":"recordCount","in":"query","description":"Number of records to be returned per screen","schema":{"maximum":250,"minimum":1,"type":"integer","default":30}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}}}}}}}},"400":{"description":"Invalid input parameter(-s)","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Specified chat ID doesn`t exist","content":{}}},"x-api-group":"glip/chats/tasks","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Heavy","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/tasks","x-rewrite-uri-to":"/glip/v1/chats/$1/tasks","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/chats/52342/tasks?recordCount=2\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"status\": \"InProgress\",\n \"subject\": \"Discuss new API\",\n \"assignees\": [\n {\"id\": \"42311\", \"status\": \"Pending\"},\n {\"id\": \"6634\", \"status\": \"Pending\"},\n {\"id\": \"con987\", \"status\": \"Completed\"}],\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00.000Z\",\n \"dueDate\": \"2018-08-2T00:00:00.000Z\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"recurrence\": {\n \"schedule\": \"None\",\n \"endingCondition\": \"None\",\n },\n \"attachments\": [{\n \"id\": \"file123\",\n \"type\": \"File\",\n \"name\": \"testfile123.test\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/524300/testfile123.test\"\n }, {\n \"id\": \"8239\"\n \"type\": \"File\",\n \"name\": \"Scheme.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/92373/scheme.png\"\n }]\n }, {\n \"id\": \"tsk123\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T17:24:34\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"status\": \"Pending\",\n \"subject\": \"Check mailbox\",\n \"assignees\": [{\"id\": \"con987\"}],\n \"completenessCondition\": \"Simple\",\n \"color\": \"Black\",\n \"recurrence\": {\n \"schedule\": \"Weekdays\",\n \"endingCondition\": \"Day\",\n \"endingAfter\": 10,\n \"endingOn\": \"2020-12-31T00:00:00\"\n }\n }],\n \"navigation\": {\n \"nextPageToken\": \"62hdfjhq87xjh\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"}]},"post":{"tags":["Tasks"],"summary":"Create Task","description":"Creates a task in the specified chat.","operationId":"createTask","parameters":[{"name":"chatId","in":"path","description":"Internal identifier of a chat","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"required":["assignees","subject"],"type":"object","properties":{"subject":{"type":"string","description":"Task name/subject. Max allowed length is 250 characters."},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessCondition":{"type":"string","default":"Simple","enum":["Simple","AllAssignees","Percentage"]},"startDate":{"type":"string","description":"Task start date in UTC time zone.","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time in UTC time zone.","format":"date-time"},"color":{"type":"string","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group / search by. Max allowed legth is 100 characters."},"description":{"type":"string","description":"Task details. Max allowed legth is 102400 characters (100kB)."},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}}}},"required":true},"responses":{"201":{"description":"Task information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}}}}},"400":{"description":"Invalid input parameter(-s)","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Specified chat ID doesn`t exist","content":{}}},"x-api-group":"glip/tasks","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/chats/(.*)/tasks","x-rewrite-uri-to":"/glip/v1/chats/$1/tasks","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"title":"Non-Recurring Task","request":"POST /restapi/v1.0/glip/chats/52342/tasks\n\n{\n \"subject\": \"Discuss new API\",\n \"assignees\": [ {\"id\": \"42311\"}, {\"id\": \"6634\"}, {\"id\": \"con987\"} ],\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00\",\n \"dueDate\": \"2018-08-02T00:00:00\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"attachments\": [ {\"id\": \"file123\"}, {\"id\": \"8239\"} ]\n}\n","response":"HTTP 201 Created\n\n{\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\"],\n \"status\": \"Pending\",\n \"subject\": \"Discuss new API\",\n \"assignees\": [\n {\"id\": \"42311\", \"status\": \"Pending\"},\n {\"id\": \"6634\", \"status\": \"Pending\"},\n {\"id\": \"con987\", \"status\": \"Pending\"}],\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00\",\n \"dueDate\": \"2018-08-02T00:00:00\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"recurrence\": {\n \"schedule\": \"None\",\n \"endingCondition\": \"None\",\n },\n \"attachments\": [{\n \"id\": \"file123\",\n \"type\": \"File\",\n \"name\": \"testfile123.test\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/524300/testfile123.test\"\n }, {\n \"id\": \"8239\"\n \"type\": \"File\",\n \"name\": \"Scheme.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/92373/scheme.png\"\n }]\n}\n"},{"title":"Recurring Task","request":"POST /restapi/v1.0/glip/chats/20493418498/tasks\n\n{\n \"subject\": \"subject\",\n \"assignees\": [ {\"id\": \"1218334020\"}],\n \"completenessCondition\": \"Simple\",\n \"startDate\": \"2017-08-01T13:00:00Z\",\n \"dueDate\": \"2017-08-02T13:00:00Z\",\n \"color\": \"Red\",\n \"section\": \"section\",\n \"description\": \"description\",\n \"recurrence\": {\n \"schedule\": \"Daily\",\n \"endingCondition\": \"Count\",\n \"endingAfter\": 5\n }\n}\n","response":"HTTP 201 Created\n{\n \"id\": \"90863468553\",\n \"assignees\": [\n {\n \"id\": \"1218334020\"\n }\n ],\n \"chatIds\": [\n \"20493418498\"\n ],\n \"completenessCondition\": \"Simple\",\n \"color\": \"Red\",\n \"creationTime\": \"2019-07-11T15:11:58Z\",\n \"creator\": {\n \"id\": \"1218334020\"\n },\n \"description\": \"description\",\n \"dueDate\": \"2017-08-02T13:00:00Z\",\n \"lastModifiedTime\": \"2019-07-11T15:11:58Z\",\n \"recurrence\": {\n \"schedule\": \"Daily\",\n \"endingCondition\": \"Count\",\n \"endingAfter\": 5\n },\n \"section\": \"section\",\n \"startDate\": \"2017-08-01T13:00:00Z\",\n \"status\": \"Pending\",\n \"subject\": \"subject\",\n \"type\": \"Task\"\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/tasks/{taskId}":{"get":{"tags":["Tasks"],"summary":"Get Task","description":"Returns information about the specified task(s) by ID(s).","operationId":"readTask","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task, or comma separated list of task IDs","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Task Information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}}}}},"400":{"description":"Invalid input parameter(-s)","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Requested task ID doesn`t exist","content":{}}},"x-api-group":"glip/tasks","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/tasks/(.*)","x-rewrite-uri-to":"/glip/v1/tasks/$1","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"title":"Single Task","request":"GET /restapi/v1.0/glip/tasks/546372\n","response":"HTTP 200 OK\n\n{\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"subject\": \"Discuss new API\",\n \"assignees\": [\n {\"id\": \"42311\", \"status\": \"Pending\"},\n {\"id\": \"6634\", \"status\": \"Pending\"},\n {\"id\": \"con987\", \"status\": \"Completed\"}],\n \"status\": \"InProgress\",\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00\",\n \"dueDate\": \"2018-08-2T00:00:00\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"recurrence\": {\n \"schedule\": \"None\",\n \"endingCondition\": \"None\",\n },\n \"attachments\": [{\n \"id\": \"file123\",\n \"type\": \"File\",\n \"name\": \"testfile123.test\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/524300/testfile123.test\"\n }, {\n \"id\": \"8239\"\n \"type\": \"File\",\n \"name\": \"Scheme.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/92373/scheme.png\"\n }]\n}\n"},{"title":"Multiple Tasks","request":"GET /restapi/v1.0/glip/tasks/546372,109238,184748\n","response":"HTTP 207 Multi-status\nContent-Type: application/json\n\n[\n {\n \"status\": 200,\n \"headers\": [ ... ],\n \"resourceId\": \"546372\",\n \"body\": {\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"subject\": \"Discuss new API\",\n \"assignees\": [\n {\"id\": \"42311\", \"status\": \"Pending\"},\n {\"id\": \"6634\", \"status\": \"Pending\"},\n {\"id\": \"con987\", \"status\": \"Completed\"}],\n \"status\": \"InProgress\",\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00.000Z\",\n \"dueDate\": \"2018-08-2T00:00:00.000Z\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"recurrence\": {\n \"schedule\": \"None\",\n \"endingCondition\": \"None\",\n },\n \"attachments\": [{\n \"id\": \"file123\",\n \"type\": \"File\",\n \"name\": \"testfile123.test\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/524300/testfile123.test\"\n }, {\n \"id\": \"8239\"\n \"type\": \"File\",\n \"name\": \"Scheme.png\",\n \"contentUri\": \"https://media.ringcentral.com//web/customer_files/92373/scheme.png\"\n }]\n }\n }, {\n \"status\": 404,\n \"headers\": [ ... ],\n \"resourceId\": \"109238\",\n \"body\": {\n \"errors\": [{\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [taskId] is not found.\",\n \"parameterName\": \"taskId\"\n }]\n }\n }, {\n \"status\": 200,\n \"headers\": [ ... ],\n \"resourceId\": \"184748\",\n \"body\": {\n \"id\": \"184748\",\n \"creationTime\": \"2019-03-07T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T17:24:34\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\",\"12345\",\"9234829\"],\n \"subject\": \"Check mailbox\",\n \"assignees\": [\n {\"id\": \"con987\"}],\n \"status\": \"Pending\",\n \"completenessCondition\": \"Simple\",\n \"color\": \"Black\",\n \"recurrence\": {\n \"schedule\": \"Weekdays\",\n \"endingCondition\": \"Date\",\n \"endingAfter\": 10,\n \"endingOn\": \"2020-12-31T00:00:00\"\n }\n }\n }\n]\n"}],"x-error-codes":null},"delete":{"tags":["Tasks"],"summary":"Delete Task","description":"Deletes the specified task.","operationId":"deleteTask","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Task with the specified ID doesn`t exist","content":{}}},"x-api-group":"glip/tasks","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/tasks/(.*)","x-rewrite-uri-to":"/glip/v1/tasks/$1","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/glip/tasks/tsk123\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null},"patch":{"tags":["Tasks"],"summary":"Patch Task","description":"Updates the specified task by ID.","operationId":"patchTask","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"Task name/subject. Max allowed length is 250 characters."},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessCondition":{"type":"string","enum":["Simple","AllAssignees","Percentage"]},"startDate":{"type":"string","description":"Task start date in UTC time zone","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time in UTC time zone","format":"date-time"},"color":{"type":"string","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by. Max allowed legth is 100 characters"},"description":{"type":"string","description":"Task details. Max allowed legth is 102400 characters (100kB)"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","enum":["File","Note","Event","Card"]}}}}}}}},"required":false},"responses":{"200":{"description":"Updated Tasks","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Datetime of the task creation in UTC time zone.","format":"datetime"},"lastModifiedTime":{"type":"string","description":"Datetime of the last modification of the task in UTC time zone.","format":"datetime"},"type":{"type":"string","description":"Type of a task","enum":["Task"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"chatIds":{"type":"array","description":"Chat IDs where the task is posted or shared.","items":{"type":"string"}},"status":{"type":"string","description":"Status of task execution","enum":["Pending","InProgress","Completed"]},"subject":{"type":"string","description":"Name/subject of a task"},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"},"status":{"type":"string","description":"Status of the task execution by assignee","enum":["Pending","Completed"]}}}},"completenessCondition":{"type":"string","description":"Specifies how to determine task completeness","enum":["Simple","AllAssignees","Percentage"]},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of the task with the specified percentage completeness condition"},"startDate":{"type":"string","description":"Task start date","format":"date-time"},"dueDate":{"type":"string","description":"Task due date/time","format":"date-time"},"color":{"type":"string","description":"Font color of a post with the current task","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"section":{"type":"string","description":"Task section to group/search by"},"description":{"type":"string","description":"Task details"},"recurrence":{"type":"object","properties":{"schedule":{"type":"string","description":"Task recurrence settings. For non-periodic tasks the value is 'None'","enum":["None","Daily","Weekdays","Weekly","Monthly","Yearly"]},"endingCondition":{"type":"string","description":"Task ending condition","enum":["None","Count","Date"]},"endingAfter":{"maximum":10,"minimum":1,"type":"integer","description":"Count of iterations of periodic tasks"},"endingOn":{"type":"string","description":"End date of periodic task","format":"date-time"}}},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a file"},"type":{"type":"string","description":"Attachment type (currently only `File` value is supported).","enum":["File"]},"name":{"type":"string","description":"Name of the attached file (including extension name)."},"contentUri":{"type":"string","description":"Link to an attachment content"}}}}}}}}}}}},"400":{"description":"Invalid input parameter(-s)","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Task with the specified ID doesn`t exist","content":{}}},"x-api-group":"glip/tasks","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/tasks/(.*)","x-rewrite-uri-to":"/glip/v1/tasks/$1","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"title":"Update Non-Recurring Task","request":"PATCH /restapi/v1.0/glip/tasks/546372\n\n{\n \"subject\": \"Discuss new API\",\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00\",\n \"dueDate\": \"2018-08-02T00:00:00\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\"\n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"546372\",\n \"creationTime\": \"2018-07-31T18:00:00.000Z\",\n \"lastModifiedTime\": \"2018-07-31T18:00:00.000Z\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\"],\n \"subject\": \"Discuss new API\",\n \"assignees\": [\n {\"id\": \"42311\", \"status\": \"Pending\"},\n {\"id\": \"6634\", \"status\": \"Pending\"},\n {\"id\": \"con987\", \"status\": \"Pending\"}],\n \"status\": \"Pending\",\n \"completenessCondition\": \"AllAssignees\",\n \"startDate\": \"2018-07-31T00:00:00\",\n \"dueDate\": \"2018-08-02T00:00:00\",\n \"color\": \"Red\",\n \"section\": \"RnD\",\n \"description\": \"Discuss with JP the prototype of new API\",\n \"recurrence\": {\n \"schedule\": \"None\",\n \"endingCondition\": \"None\",\n },\n \"attachments\": [{\n \"id\": \"file123\",\n \"type\": \"File\",\n \"name\": \"testfile123.test\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/524300/testfile123.test\"\n }, {\n \"id\": \"8239\"\n \"type\": \"File\",\n \"name\": \"Scheme.png\",\n \"contentUri\": \"https://media.ringcentral.com/web/customer_files/92373/scheme.png\"\n }]\n}\n"},{"title":"Update Recurring Task","request":"PATCH /restapi/v1.0/glip/tasks/tsk123\n\n{\n \"subject\": \"Check mailbox\",\n \"recurrence\": {\n \"schedule\": \"Weekdays\",\n \"endingCondition\": \"Date\",\n \"endingAfter\": 10,\n \"endingOn\": \"2020-12-31T00:00:00\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"tsk123\",\n \"creationTime\": \"2019-03-10T12:35:93\",\n \"lastModifiedTime\": \"2019-03-10T12:35:93\",\n \"type\": \"Task\",\n \"creator\": {\"id\": \"con987\"},\n \"chatIds\": [\"52342\"],\n \"subject\": \"Check mailbox\",\n \"assignees\": [{\"id\": \"con987\"}],\n \"status\": \"Pending\",\n \"completenessCondition\": \"Simple\",\n \"startDate\": \"2019-03-10T12:35:93\",\n \"dueDate\": \"2019-03-10T23:59:59\",\n \"color\": \"Black\",\n \"recurrence\": {\n \"schedule\": \"Weekdays\",\n \"endingCondition\": \"Date\",\n \"endingAfter\": 10,\n \"endingOn\": \"2020-12-31T00:00:00\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/tasks/{taskId}/complete":{"post":{"tags":["Tasks"],"summary":"Complete Task","description":"Completes a task in the specified chat.","operationId":"completeTask","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Completeness status. 'Mandatory' if `completenessCondition` is set to `Simple`, otherwise 'Optional'","enum":["Incomplete","Complete"]},"assignees":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an assignee"}}}},"completenessPercentage":{"maximum":100,"minimum":0,"type":"integer","description":"Current completeness percentage of a task with the 'Percentage' completeness condition. 'Mandatory' if `completenessCondition` is set to `Percentage`, otherwise 'Optional'"}}}}},"required":true},"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Invalid input parameter(-s)","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Requested task ID doesn`t exist","content":{}}},"x-api-group":"glip/tasks/complete","x-metered-api":true,"x-metering-group":"System","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/glip/tasks/(.*)/complete","x-rewrite-uri-to":"/glip/v1/tasks/$1/complete","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"title":"Task #1","request":"POST /restapi/v1.0/glip/tasks/546372/complete\n{\n \"assignees\": [{\"id\": 42311}, {\"id\": 6634}, {\"id\": 56432}]\n}\n","response":"HTTP 204 No Content\n"},{"title":"Task #2","request":"POST /restapi/v1.0/glip/tasks/67899/complete\n{\n \"status\": \"Complete\"\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/persons/{personId}":{"get":{"tags":["Glip Profile"],"summary":"Get Person","description":"Returns a user or multiple users by their ID(s). Batch request is supported.","operationId":"readGlipPerson","parameters":[{"name":"personId","in":"path","description":"Internal identifier of a user to be returned, the maximum number of IDs is 30","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"firstName":{"type":"string","description":"First name of a user"},"lastName":{"type":"string","description":"Last name of a user"},"email":{"type":"string","description":"Email of a user"},"avatar":{"type":"string","description":"Photo of a user"},"companyId":{"type":"string","description":"Internal identifier of a company"},"creationTime":{"type":"string","description":"Time of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Time of the last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}}}},"207":{"description":"Mixed Result","content":{}},"403":{"description":"You do not have permissions to get such kind of information","content":{}},"404":{"description":"Person Not Found","content":{}}},"x-api-group":"glip/persons","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/persons/(.*)","x-rewrite-uri-to":"/glip/v1/persons/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/persons/61307231006\n","response":"HTTP 200 OK\n\n{\n \"id\": \"61307231006\",\n \"firstName\": \"Iren\",\n \"lastName\": \"Fox\",\n \"gender\": null,\n \"email\": \"iren.fox@example.com\",\n \"location\": null,\n \"avatar\": \"https://example.com/web/customer_files/668356558860/15921044.jpg?Expires=2075494478&AWSAccessKeyId=AKIAJROPQDFTIHBTLJJQ&Signature=9sOxJ2BSCsRR1JeTZSywOa6Q8Ds%3D\",\n \"companyId\": \"37439510\",\n \"creationTime\": \"2015-10-06T12:39:43.448Z\",\n \"lastModifiedTime\": \"2018-12-11T07:53:52.100Z\",\n \"employeeSince\": null,\n \"jobTitle\": \"Designer\",\n \"birthday\": \"April 25\",\n \"webPage\": \"www.iren.fox.example.com\"\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/companies/{companyId}":{"get":{"tags":["Glip Profile"],"summary":"Get Company Info","description":"Returns information about one or more companies by their IDs.","operationId":"readGlipCompany","parameters":[{"name":"companyId","in":"path","description":"Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["creationTime","id","lastModifiedTime"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"},"name":{"type":"string","description":"Name of a company"},"domain":{"type":"string","description":"Domain name of a company"},"creationTime":{"type":"string","description":"Datetime of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"},"lastModifiedTime":{"type":"string","description":"Datetime of last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"}}}},"multipart/mixed":{"schema":{"required":["creationTime","id","lastModifiedTime"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to"},"name":{"type":"string","description":"Name of a company"},"domain":{"type":"string","description":"Domain name of a company"},"creationTime":{"type":"string","description":"Datetime of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"},"lastModifiedTime":{"type":"string","description":"Datetime of last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format"}}}}}},"207":{"description":"Mixed Result","content":{}},"403":{"description":"You do not have permissions to get such kind of information","content":{}},"404":{"description":"Company Not Found","content":{}}},"x-api-group":"glip/companies","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/companies/(.*)","x-rewrite-uri-to":"/glip/v1/companies/$1","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/companies/37439510\n","response":"HTTP 200 OK\n\n{\n \"id\": \"37439510\",\n \"name\": \"RingCentral\",\n \"domain\": \"ringcentral.com\",\n \"creationTime\": \"2014-05-15T05:23:08.867Z\",\n \"lastModifiedTime\": \"2018-12-10T13:37:43.156Z\"\n}\n\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/groups/{groupId}/webhooks":{"get":{"tags":["Glip Webhooks"],"summary":"Get Webhooks in Group","description":"Returns webhooks which are available for the current user by group ID.","operationId":"listGlipGroupWebhooks","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}}}}},"404":{"description":"Group with specified ID is not found.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/webhooks","x-rewrite-uri-to":"/glip/v1/groups/$1/webhooks","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/groups/76176056322/webhooks\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"3308dae2-3b0c-495f-9f00-f66574af42f7\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T08:02:10.388Z\",\n \"lastModifiedTime\": \"2018-12-11T08:02:10.388Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/3308dae2-3b0c-495f-9f00-f66574af42f7\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"a530f8af-59fe-414b-b368-f120a1388a9b\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T08:02:38.665Z\",\n \"lastModifiedTime\": \"2018-12-11T08:02:38.665Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/a530f8af-59fe-414b-b368-f120a1388a9b\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"f02860a0-a421-40dd-977c-1b9330127ede\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T08:03:46.721Z\",\n \"lastModifiedTime\": \"2018-12-11T08:03:46.721Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/f02860a0-a421-40dd-977c-1b9330127ede\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"6682f6b7-278c-46f3-a516-f474a887ef2e\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T14:54:03.032Z\",\n \"lastModifiedTime\": \"2018-12-11T14:54:03.032Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/6682f6b7-278c-46f3-a516-f474a887ef2e\",\n \"status\": \"Active\"\n }\n ]\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]},"post":{"tags":["Glip Webhooks"],"summary":"Create Webhook in Group","description":"Creates a new webhook","operationId":"createGlipGroupWebhook","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/webhooks","x-rewrite-uri-to":"/glip/v1/groups/$1/webhooks","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/groups/6090227714/webhooks\n","response":"HTTP 200 OK\n\n{\n \"id\": \"3053f6cf-b6de-418c-a6cd-2eb222cdab4e\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"6090227714\"\n ],\n \"creationTime\": \"2018-12-11T16:29:02.185Z\",\n \"lastModifiedTime\": \"2018-12-11T16:29:02.185Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/3053f6cf-b6de-418c-a6cd-2eb222cdab4e\",\n \"status\": \"Active\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/glip/webhooks":{"get":{"tags":["Glip Webhooks"],"summary":"Get Webhooks","description":"Returns a list of all webhooks associated with the current account.","operationId":"listGlipWebhooks","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}}}}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/webhooks","x-rewrite-uri-to":"/glip/v1/webhooks","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/webhooks\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"id\": \"3308dae2-3b0c-495f-9f00-f66574af42f7\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T08:02:10.388Z\",\n \"lastModifiedTime\": \"2018-12-11T08:02:10.388Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/3308dae2-3b0c-495f-9f00-f66574af42f7\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"a530f8af-59fe-414b-b368-f120a1388a9b\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T08:02:38.665Z\",\n \"lastModifiedTime\": \"2018-12-11T17:05:29.244Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/a530f8af-59fe-414b-b368-f120a1388a9b\",\n \"status\": \"Suspended\"\n },\n {\n \"id\": \"b1048ad2-e865-4dba-9f78-5841422289f3\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"6090227714\"\n ],\n \"creationTime\": \"2018-12-11T08:07:58.211Z\",\n \"lastModifiedTime\": \"2018-12-11T08:07:58.211Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/b1048ad2-e865-4dba-9f78-5841422289f3\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"e399bbb6-cf20-4784-820f-610c83338488\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"6090227714\"\n ],\n \"creationTime\": \"2018-12-11T08:22:33.375Z\",\n \"lastModifiedTime\": \"2018-12-11T08:22:33.375Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/e399bbb6-cf20-4784-820f-610c83338488\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"6682f6b7-278c-46f3-a516-f474a887ef2e\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"76176056322\"\n ],\n \"creationTime\": \"2018-12-11T14:54:03.032Z\",\n \"lastModifiedTime\": \"2018-12-11T14:54:03.032Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/6682f6b7-278c-46f3-a516-f474a887ef2e\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"9cf18394-3e28-40d4-a39d-4a78866a0f3c\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"6090227714\"\n ],\n \"creationTime\": \"2018-12-11T16:23:44.882Z\",\n \"lastModifiedTime\": \"2018-12-11T16:23:44.882Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/9cf18394-3e28-40d4-a39d-4a78866a0f3c\",\n \"status\": \"Active\"\n },\n {\n \"id\": \"3053f6cf-b6de-418c-a6cd-2eb222cdab4e\",\n \"creatorId\": \"61307231006\",\n \"groupIds\": [\n \"6090227714\"\n ],\n \"creationTime\": \"2018-12-11T16:29:02.185Z\",\n \"lastModifiedTime\": \"2018-12-11T16:42:11.933Z\",\n \"uri\": \"https://hooks.glip.com/webhook/v2/3053f6cf-b6de-418c-a6cd-2eb222cdab4e\",\n \"status\": \"Active\"\n }\n ]\n}\n\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/glip/webhooks/{webhookId}":{"get":{"tags":["Glip Webhooks"],"summary":"Get Webhook","description":"Returns webhooks(s) with the specified id(s).","operationId":"readGlipWebhook","parameters":[{"name":"webhookId","in":"path","description":"Internal identifier of a webhook or comma separated list of webhooks IDs","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a webhook"},"creatorId":{"type":"string","description":"Internal identifier of the user who created a webhook"},"groupIds":{"type":"array","description":"Internal identifiers of groups where a webhook has been created","items":{"type":"string"}},"creationTime":{"type":"string","description":"Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"uri":{"type":"string","description":"Public link to send a webhook payload"},"status":{"type":"string","description":"Current status of a webhook","enum":["Active","Suspended","Deleted"]}}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Webhooks not found.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/webhooks/(.*)","x-rewrite-uri-to":"/glip/v1/webhooks/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/webhooks/3308dae2-3b0c-495f-9f00-f66574af42f7,f02860a0-a421-40dd-977c-1b9330127ede\n","response":"HTTP 200 OK\n\n{\n --glboundary_5zIqkI3QTHi40ecT5ef2M4vA1bGkoiSXNPBcAmFH\nContent-type: application/json; charset=utf-8\nContent-length: 44\n\n{\"response\":[{\"status\":200},{\"status\":200}]}\n--glboundary_5zIqkI3QTHi40ecT5ef2M4vA1bGkoiSXNPBcAmFH\nContent-type: application/json; charset=utf-8\nContent-length: 283\n\n{\"id\":\"3308dae2-3b0c-495f-9f00-f66574af42f7\",\"creatorId\":\"61307231006\",\"groupIds\":[\"76176056322\"],\"creationTime\":\"2018-12-11T08:02:10.388Z\",\"lastModifiedTime\":\"2018-12-11T08:02:10.388Z\",\"uri\":\"https://hooks.glip.com/webhook/v2/3308dae2-3b0c-495f-9f00-f66574af42f7\",\"status\":\"Active\"}\n--glboundary_5zIqkI3QTHi40ecT5ef2M4vA1bGkoiSXNPBcAmFH\nContent-type: application/json; charset=utf-8\nContent-length: 283\n\n{\"id\":\"f02860a0-a421-40dd-977c-1b9330127ede\",\"creatorId\":\"61307231006\",\"groupIds\":[\"76176056322\"],\"creationTime\":\"2018-12-11T08:03:46.721Z\",\"lastModifiedTime\":\"2018-12-11T08:03:46.721Z\",\"uri\":\"https://hooks.glip.com/webhook/v2/f02860a0-a421-40dd-977c-1b9330127ede\",\"status\":\"Active\"}\n--glboundary_5zIqkI3QTHi40ecT5ef2M4vA1bGkoiSXNPBcAmFH--\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]},"delete":{"tags":["Glip Webhooks"],"summary":"Delete Webhook","description":"Deletes the webhook by ID.","operationId":"deleteGlipWebhook","parameters":[{"name":"webhookId","in":"path","description":"Internal identifier of a webhook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The resource was deleted successfully.","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Webhook not found.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/webhooks/(.*)","x-rewrite-uri-to":"/glip/v1/webhooks/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/glip/webhooks/f02860a0-a421-40dd-977c-1b9330127ede\n","response":"HTTP 200 OK\n\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/webhooks/{webhookId}/activate":{"post":{"tags":["Glip Webhooks"],"summary":"Activate Webhook","description":"Activates webhook by ID.","operationId":"activateGlipWebhook","parameters":[{"name":"webhookId","in":"path","description":"Internal identifier of a webhook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Webhook not found.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/webhooks/(.*)","x-rewrite-uri-to":"/glip/v1/webhooks/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/webhooks/3053f6cf-b6de-418c-a6cd-2eb222cdab4e/activate\n","response":"HTTP 200 OK\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/webhooks/{webhookId}/suspend":{"post":{"tags":["Glip Webhooks"],"summary":"Suspend Webhook","description":"Suspends webhook by ID.","operationId":"suspendGlipWebhook","parameters":[{"name":"webhookId","in":"path","description":"Internal identifier of a webhook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Webhook not found.","content":{}}},"x-api-group":"glip/webhooks","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/webhooks/(.*)","x-rewrite-uri-to":"/glip/v1/webhooks/$1","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/webhooks/3053f6cf-b6de-418c-a6cd-2eb222cdab4e/suspend\n","response":"HTTP 200 OK\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/preferences":{"get":{"tags":["Glip Profile"],"summary":"Get Preferences","description":"Returns information about user preferences.","operationId":"readGlipPreferences","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"chats":{"type":"object","properties":{"maxCount":{"type":"integer"},"leftRailMode":{"type":"string","default":"CombineAllChatTypes","enum":["SeparateAllChatTypes","SeparateConversationsAndTeams","CombineAllChatTypes"]}}}}}}}}},"x-api-group":"glip/preferences","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/preferences/?","x-rewrite-uri-to":"/glip/v1/preferences","x-docs-level":"Public","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/glip/groups":{"get":{"tags":["Chats"],"summary":"Get User Groups","description":"Returns the list of groups where the user is a member.","operationId":"listGlipGroups","parameters":[{"name":"type","in":"query","description":"Type of groups to be fetched (by default all type of groups will be fetched)","schema":{"type":"string","enum":["Group","Team","PrivateChat","PersonalChat"]}},{"name":"recordCount","in":"query","description":"Number of groups to be fetched by one request. The maximum value is 250, by default - 30","schema":{"maximum":250,"type":"integer","default":30}},{"name":"pageToken","in":"query","description":"Pagination token.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of groups/teams/private chats","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}},"404":{"description":"Group with the specified ID is not found.","content":{}}},"deprecated":true,"x-api-group":"glip/groups","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-throttling-group":"Medium","x-notifications":[{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"eventType":{"type":"string","description":"Type of a group event. Only the person who joined/was added to a group will receive 'GroupJoined' notification. Only the person who left/was removed from a group will receive 'GroupLeft' notification","enum":["GroupRenamed","GroupJoined","GroupLeft","GroupChanged"]}}}],"x-rewrite-uri-from":"/restapi/v1.0/glip/groups","x-rewrite-uri-to":"/glip/v1/groups","x-beta-api":true,"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"post":{"tags":["Chats"],"summary":"Create Group","description":"Creates a new private chat/team.","operationId":"createGlipGroup","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Type of a group to be created. 'PrivateChat' is a group of 2 members. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Team"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members. For 'PrivateChat' group type 2 members only are supported”","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"Forbidden","content":{}}},"deprecated":true,"x-api-group":"glip/groups","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups","x-rewrite-uri-to":"/glip/v1/groups","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-throttling-group":"Medium","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/groups/{groupId}":{"get":{"tags":["Chats"],"summary":"Get Group","description":"Returns information about a group or multiple groups by their ID(s). Batch request is supported.","operationId":"readGlipGroup","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group to be returned, the maximum number of IDs is 30","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}},"multipart/mixed":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}}}},"207":{"description":"Mixed Result","content":{}},"403":{"description":"You do not have permissions to get such kind of information.","content":{}},"404":{"description":"Person Not Found.","content":{}}},"deprecated":true,"x-api-group":"glip/groups","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/(.*)","x-rewrite-uri-to":"/glip/v1/groups/$1","x-docs-level":"Public","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/glip/groups/{groupId}/bulk-assign":{"post":{"tags":["Chats"],"summary":"Edit Group Members","description":"Updates group members. **Please note:** Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.","operationId":"assignGlipGroupMembers","parameters":[{"name":"groupId","in":"path","description":"Internal identifier of a group","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"addedPersonIds":{"type":"array","description":"List of users to be added to a team","items":{"type":"string"}},"addedPersonEmails":{"type":"array","description":"List of user email addresses to be added to a team (i.e. as guests)","items":{"type":"string"}},"removedPersonIds":{"type":"array","description":"List of users to be removed from a team","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a group"},"type":{"type":"string","description":"Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user","enum":["PrivateChat","Group","Team","PersonalChat"]},"isPublic":{"type":"boolean","description":"For 'Team' group type only. Team access level"},"name":{"type":"string","description":"For 'Team' group type only. Team name"},"description":{"type":"string","description":"For 'Team' group type only. Team description"},"members":{"type":"array","description":"“List of glip members”","items":{"type":"string","description":"Internal identifier of a member"}},"creationTime":{"type":"string","description":"Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"403":{"description":"Forbidden","content":{}}},"deprecated":true,"x-api-group":"glip/groups","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/groups/([0-9]+)/bulk-assign","x-rewrite-uri-to":"/glip/v1/groups/$1/bulk-assign","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-throttling-group":"Medium","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/glip/posts":{"get":{"tags":["Posts"],"summary":"Get Posts","description":"Returns posts available for the current user by group ID.","operationId":"listGlipPosts","parameters":[{"name":"groupId","in":"query","description":"Identifier of a group to filter posts","schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Token of a page to be returned","schema":{"type":"string"}},{"name":"recordCount","in":"query","description":"Number of records to be returned. The maximum value is 250, by default - 30","schema":{"maximum":250,"type":"integer","format":"int64","default":30}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of posts","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}},"navigation":{"type":"object","properties":{"prevPageToken":{"type":"string","description":"Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"},"nextPageToken":{"type":"string","description":"Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens"}}}}}}}},"404":{"description":"Group with the specified ID is not found.","content":{}}},"deprecated":true,"x-api-group":"glip/posts","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/posts","x-rewrite-uri-to":"/glip/v1/posts","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]},"post":{"tags":["Posts"],"summary":"Create Post","description":"Creates a post.","operationId":"createPost","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"string"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)."},"text":{"type":"string","description":"Text of a post"},"groupId":{"type":"string","description":"Internal identifier of a group"},"attachments":{"type":"array","description":"List of attachments to be posted","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of attachment","default":"Card","enum":["Card","Event","Note"]},"title":{"type":"string","description":"Attachment title"},"fallback":{"type":"string","description":"Default message returned in case the client does not support interactive messages"},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black'"},"intro":{"type":"string","description":"Introductory text displayed directly above a message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"text":{"type":"string","description":"Text of attachment (up to 1000 chars), supports GlipDown"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Individual subsections within a message","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings. For non-periodic events the value is 'None'. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending an event"}}}},"personIds":{"type":"array","items":{"type":"string"}},"system":{"type":"boolean"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a post"},"groupId":{"type":"string","description":"Internal identifier of a group a post belongs to"},"type":{"type":"string","description":"Type of a post","enum":["TextMessage","PersonJoined","PersonsAdded"]},"text":{"type":"string","description":"For 'TextMessage' post type only. Text of a message"},"creatorId":{"type":"string","description":"Internal identifier of a user - author of a post"},"addedPersonIds":{"type":"array","description":"For 'PersonsAdded' post type only. Identifiers of persons added to a group","items":{"type":"string"}},"creationTime":{"type":"string","description":"Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"lastModifiedTime":{"type":"string","description":"Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format","format":"date-time"},"attachments":{"type":"array","description":"List of posted attachments","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an attachment"},"type":{"type":"string","description":"Type of an attachment","default":"Card","enum":["Card","Event","File","Note","Task"]},"fallback":{"type":"string","description":"A string of default text that will be rendered in the case that the client does not support Interactive Messages"},"intro":{"type":"string","description":"A pretext to the message"},"author":{"type":"object","properties":{"name":{"type":"string","description":"Name of a message author"},"uri":{"type":"string","description":"Link to an author's name"},"iconUri":{"type":"string","description":"Link to an image displayed to the left of an author's name; sized 82x82px"}},"description":"Information about the author"},"title":{"type":"string","description":"Message title"},"text":{"type":"string","description":"A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown)"},"imageUri":{"type":"string","description":"Link to an image displayed at the bottom of a message"},"thumbnailUri":{"type":"string","description":"Link to an image preview displayed to the right of a message (82x82)"},"fields":{"type":"array","description":"Information on navigation","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of an individual field"},"value":{"type":"string","description":"Value of an individual field (supports Markdown)"},"style":{"type":"string","description":"Style of width span applied to a field","default":"Short","enum":["Short","Long"]}}}},"footnote":{"type":"object","properties":{"text":{"type":"string","description":"Text of a footer"},"iconUri":{"type":"string","description":"Link to an icon displayed to the left of a footer; sized 32x32px"},"time":{"type":"string","description":"Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"}},"description":"Message footer information"},"creatorId":{"type":"string","description":"Internal identifier of a person created an event"},"startTime":{"type":"string","description":"Datetime of starting an event"},"endTime":{"type":"string","description":"Datetime of ending an event"},"allDay":{"type":"boolean","description":"Indicates whether an event has some specific time slot or lasts for the whole day(s)","default":false},"recurrence":{"type":"string","description":"Event recurrence settings.","enum":["None","Day","Weekday","Week","Month","Year"]},"endingCondition":{"type":"string","description":"Condition of ending"},"endingAfter":{"type":"integer","description":"Count of iterations. For periodic events only"},"endingOn":{"type":"string","description":"Iterations end datetime for periodic events","default":"None","enum":["None","Count","Date"]},"color":{"type":"string","description":"Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card","default":"Black","enum":["Black","Red","Orange","Yellow","Green","Blue","Purple","Magenta"]},"location":{"type":"string","description":"Event location"},"description":{"type":"string","description":"Event details"}}}},"mentions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user"},"type":{"type":"string","description":"Type of mention","enum":["Person","Team","File","Link","Event","Task","Note","Card"]},"name":{"type":"string","description":"Name of a user"}}}},"activity":{"type":"string","description":"Label of activity type"},"title":{"type":"string","description":"Title of a message. (Can be set for bot's messages only)"},"iconUri":{"type":"string","description":"Link to an image used as an icon for this message"},"iconEmoji":{"type":"string","description":"Emoji used as an icon for this message"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Group not found.","content":{}}},"deprecated":true,"x-api-group":"glip/posts","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/posts","x-rewrite-uri-to":"/glip/v1/posts","x-app-permission":"Glip","x-user-permission":"Glip","x-feature":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/unified-presence":{"get":{"tags":["Presence"],"summary":"Get Unified Presence","description":"Returns the unified presence status of the requested user(s). The set of parameters returned by this method differs whether you return the requester's presence or any other user presence.","operationId":"readUnifiedPresence","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"object","properties":{"resourceId":{"type":"string","description":"Internal identifier of the resource"},"status":{"type":"integer","description":"Status code of resource retrieval"},"body":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}}}}}}},"400":{"description":"Some of parameters are missing or have invalid format.","content":{}},"404":{"description":"Resource not found","content":{}}},"x-api-group":"extension/unified-presence","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadPresence","x-user-permission":"ReadPresenceStatus","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/extension/(.*)/unified-presence","x-rewrite-uri-to":"/glip/v1/company/$1/contact/$2/presence","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"title":"Requester's Presence","request":"GET /restapi/v1.0/account/~/extension/9234829/unified-presence\n","response":"HTTP 200 OK\n\n{\n \"status\": \"Available\",\n \"glip\": {\n \"status\": \"Online\",\n \"visibility\": \"Visible\",\n \"availability\": \"Available\"\n },\n \"telephony\": {\n \"status\": \"NoCall\",\n \"visibility\": \"Visible\",\n \"availability\": \"TakeAllCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n}\n"},{"title":"Other User Presence (glip & telephony visible)","request":"GET /restapi/v1.0/account/~/extension/9234830/unified-presence\n","response":"HTTP 200 OK\n\n{\n \"status\": \"Available\",\n \"glip\": {\n \"status\": \"Online\",\n \"availability\": \"Available\"\n },\n \"telephony\": {\n \"status\": \"NoCall\",\n \"availability\": \"TakeAllCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n}\n"},{"title":"Other User Presence (glip & telephony invisible)","request":"GET /restapi/v1.0/account/~/extension/9234830/unified-presence\n","response":"HTTP 200 OK\n\n{\n \"status\": \"Offline\",\n \"glip\": {\n \"availability\": \"Available\"\n },\n \"telephony\": {\n \"availability\": \"TakeAllCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n}\n\n"},{"title":"Other User Presence (glip visible & telephony invisible)","request":"GET /restapi/v1.0/account/~/extension/9234830/unified-presence\n","response":"HTTP 200 OK\n{\n \"status\": \"Available\",\n \"glip\": {\n \"status\": \"Online\",\n \"availability\": \"Available\"\n },\n \"telephony\": {\n \"availability\": \"TakeAllCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n}\n"},{"title":"Multiple Presence","request":"GET /restapi/v1.0/account/~/extension/9234829,82347/unified-presence\n","response":"HTTP 207 Multi-status\nContent-Type: application/json\n\n[ \n {\n \"status\": 200,\n \"resourceId\": \"9234829\",\n \"body\": {\n \"status\": \"Available\",\n \"glip\": {\n \"status\": \"Online\",\n \"visibility\": \"Visible\",\n \"availability\": \"Available\"\n },\n \"telephony\": {\n \"status\": \"NoCall\",\n \"visibility\": \"Visible\",\n \"availability\": \"TakeAllCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n },\n }, {\n \"status\": 404,\n \"resourceId\": \"82347\",\n \"body\": {\n \"errors\": [{\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [contactId] is not found.\",\n \"parameterName\": \"contactId\"\n }]\n }\n }\n]\n"}],"x-error-codes":null},"patch":{"tags":["Presence"],"summary":"Update Unified Presence","description":"Updates the unified presence for the current user specified in path.","operationId":"updateUnifiedPresence","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"glip":{"type":"object","properties":{"visibility":{"type":"string","description":"Visibility setting allowing other users to see Glip presence status","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Availability setting specifing whether to receive Glip notifications or not","enum":["Available","DND"]}}},"telephony":{"type":"object","properties":{"availability":{"type":"string","description":"Telephony DND status","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Aggregated presence status of the user","enum":["Available","Offline","DND","Busy"]},"glip":{"type":"object","properties":{"status":{"type":"string","description":"Glip connection status calculated from all user's apps. Returned always for the requester's extension; returned for another users if their glip visibility is set to 'Visible'","enum":["Offline","Online"]},"visibility":{"type":"string","description":"Visibility setting allowing other users to see the user's Glip presence status; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Shows whether user wants to receive Glip notifications or not.","enum":["Available","DND"]}},"description":"Returned if *Glip* feature is switched on"},"telephony":{"type":"object","properties":{"status":{"type":"string","description":"Telephony status calculated from all user's phone numbers. Returned always for the requester's extension; returned for another users if their telephony visibility is set to 'Visible'","enum":["NoCall","Ringing","CallConnected","OnHold","ParkedCall"]},"visibility":{"type":"string","description":"Specifies if the user hardphone presence status is visible to other users; returned only for requester's extension","enum":["Visible","Invisible"]},"availability":{"type":"string","description":"Telephony DND status. Returned if *DND* feature is switched on","enum":["TakeAllCalls","DoNotAcceptAnyCalls","DoNotAcceptQueueCalls"]}},"description":"Returned if *BLF* feature is switched on"},"meeting":{"type":"object","properties":{"status":{"type":"string","description":"Meeting status calculated from all user`s meetings","enum":["NoMeeting","InMeeting"]}},"description":"Returned if *Meetings* feature is switched on"}}}}}},"400":{"description":"Some of parameters are missing or have invalid format","content":{}},"403":{"description":"User is not allowed to do this action","content":{}},"404":{"description":"Resource not found","content":{}}},"x-api-group":"extension/unified-presence","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditPresence","x-user-permission":"EditPresenceStatus","x-feature":"EditPresenceStatus","x-throttling-group":"Medium","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/extension/(.*)/unified-presence","x-rewrite-uri-to":"/glip/v1/company/$1/contact/$2/presence","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PATCH /restapi/v1.0/account/~/extension/9234829/unified-presence\n\n{\n \"glip\": {\n \"visibility\": \"Visible\",\n \"availability\": \"DND\"\n },\n \"telephony\": {\n \"availability\": \"DoNotAcceptQueueCalls\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"status\": \"DND\",\n \"glip\": {\n \"status\": \"Online\",\n \"visibility\": \"Visible\",\n \"availability\": \"DND\"\n },\n \"telephony\": {\n \"status\": \"NoCall\",\n \"visibility\": \"Invisible\",\n \"availability\": \"DoNotAcceptQueueCalls\"\n },\n \"meeting\": {\n \"status\": \"NoMeeting\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting":{"get":{"tags":["Meeting Management"],"summary":"Get Scheduled Meetings","description":"Returns a list of user meetings scheduled for the future (meetings of 'Instant' type are not included).","operationId":"listMeetings","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Scheduled Meeting List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"},"perPage":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"pageStart":{"type":"integer","format":"int32"},"pageEnd":{"type":"integer","format":"int32"}}},"navigation":{"type":"object","properties":{"nextPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"firstPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","format":"uri"}}}}}}}}}}},"x-api-group":"extension/meeting","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-user-permission":"Meetings","x-app-permission":"Meetings","x-feature":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/255537016/extension/255537016/meeting?perPage=2\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/?page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1489500211\",\n \"id\" : \"1489500211\",\n \"topic\" : \"My meeting #1\",\n \"meetingType\" : \"Scheduled\",\n \"password\" : \"123456\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1489500211?zpk=wx4B-iJI2fssahvLJu-rykyuu2oW67OirP6AK347omg.BwcAAAFmpVITBwAAHCAkNjk3ODU2MzAtY2JiOC00YzlmLWEwMWItNzlkNGFiNDFjNGRkGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-R0JsMFVHY2NhcXlWdnhBblpmYnJ5RnRNeWNQVkZ1UTEtR2Z2dnNPckp6TS5FZ0VBQUFGbXBWSVRCd0FBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1489500211?pwd=tWzAHHXJzXQ\"\n },\n \"schedule\" : {\n \"startTime\" : \"2018-11-03T12:00:00Z\",\n \"durationInMinutes\" : 30,\n \"timeZone\" : {\n \"id\" : \"57\"\n }\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : true,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \"Phone\", \"ComputerAudio\" ]\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1492006868\",\n \"id\" : \"1492006868\",\n \"topic\" : \"My meeting #2\",\n \"meetingType\" : \"Scheduled\",\n \"password\" : \"123456\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1492006868?zpk=wx4B-iJI2fssahvLJu-rykyuu2oW67OirP6AK347omg.BwcAAAFmpVITBwAAHCAkNjk3ODU2MzAtY2JiOC00YzlmLWEwMWItNzlkNGFiNDFjNGRkGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-R0JsMFVHY2NhcXlWdnhBblpmYnJ5RnRNeWNQVkZ1UTEtR2Z2dnNPckp6TS5FZ0VBQUFGbXBWSVRCd0FBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1492006868?pwd=tWzAHHXJzXQ\"\n },\n \"schedule\" : {\n \"startTime\" : \"2018-11-03T12:00:00Z\",\n \"durationInMinutes\" : 60,\n \"timeZone\" : {\n \"id\" : \"1\"\n }\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : true,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \"Phone\", \"ComputerAudio\" ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 2,\n \"totalElements\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/?page=1&perPage=2\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/?page=1&perPage=2\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Meeting Management"],"summary":"Create Meeting","description":"Creates a new meeting.","operationId":"createMeeting","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"password":{"type":"string","description":"Meeting password"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","default":false},"startHostVideo":{"type":"boolean","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"usePersonalMeetingId":{"type":"boolean","description":"If true, then personal user's meeting ID is applied for creation of this meeting"},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"recurrence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}}},"required":false},"responses":{"201":{"description":"Created Meeting","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}}}}},"x-api-group":"extension/meeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-user-permission":"Meetings","x-app-permission":"Meetings","x-feature":"EditMeetings","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"title":"Instant Meeting","request":"POST https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting\n\n{\n \"topic\": \"My meeting #2\",\n \"meetingType\": \"Instant\"\n}\n","response":"HTTP 201 Created\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1491674259\",\n \"id\" : \"1491674259\",\n \"topic\" : \"My meeting #2\",\n \"meetingType\" : \"Instant\",\n \"password\" : \"\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1491674259?zpk=7R1r164uNTjORxBU1k6fHCVCpf-kW3DR1pGh6S4svtc.BwcAAAFmpW8dBQAAHCAkYjc3NGQ5NjktM2IwYi00OGMzLWJjN2YtMzVkNmZjMjQxY2RlGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-ZklLUU4wWjI1cWEyc2ItZHREcGZFZXFqelBkRTRzcXdMcUhNOUdDUGx6dy5FZ0VBQUFGbXBXOGRCUUFBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1491674259\"\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : false,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \"Phone\", \"ComputerAudio\" ]\n}\n"},{"title":"Scheduled Meeting","request":"POST https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting\n\n{\n \"topic\": \"My Meeting #1\",\n \"meetingType\": \"Scheduled\",\n \"schedule\": {\n \"startTime\": \"2018-11-03T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"timeZone\": {\"id\" : \"1\"}\n },\n \"host\" : {\n \"id\" : \"256440016\"},\n \"password\": \"12345\",\n \"allowJoinBeforeHost\": true,\n \"startHostVideo\": true,\n \"startParticipantsVideo\": true,\n \"audioOptions\": [\n \"Phone\",\n \"ComputerAudio\"\n ]\n} \n","response":"HTTP 201 Created\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1486073088\",\n \"id\" : \"1486073088\",\n \"topic\" : \"My Meeting #1\",\n \"meetingType\" : \"Scheduled\",\n \"password\" : \"12345\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1486073088?zpk=AfmxVvGrmwtpyiKpVQfCl4vGyHm9B_pkLVyUJ2YUk0A.BwcAAAFmpWxo1AAAHCAkZTQ1YjE4YWMtYjRiMS00M2VlLTkwMDctODgyYTY0NDkwNWVhGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-b1paUWtCMlcxcjJLOGhMTGZLeTBkcHdBWlU5a3d3dTM0bXIxOXcweUdxSS5FZ0VBQUFGbXBXeG8xQUFBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1486073088?pwd=oeoDAU6FX1A\"\n },\n \"schedule\" : {\n \"startTime\" : \"2018-11-03T12:00:00Z\",\n \"durationInMinutes\" : 30,\n \"timeZone\" : {\n \"id\" : \"1\"\n }\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : true,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \"Phone\", \"ComputerAudio\" ]\n}\n"},{"title":"Scheduled Recurring Meeting","request":"POST /restapi/v1.0/account/~/extension/~/meeting\n\n {\n \"topic\": \"My Recurring Meeting #1\",\n \"meetingType\": \"ScheduledRecurring\",\n \"schedule\": {\n \"startTime\": \"2020-01-03T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"timeZone\": {\n \"id\": \"1\"\n }\n },\n \"host\": {\n \"id\": \"60952048006\"\n },\n \"password\": \"123456\",\n \"allowJoinBeforeHost\": false,\n \"startHostVideo\": false,\n \"startParticipantsVideo\": true,\n \"audioOptions\": [\n \"Phone\",\n \"ComputerAudio\"\n ],\n \"recurrence\": {\n \"frequency\": \"Daily\",\n \"interval\": \"2\",\n \"until\": \"2020-11-03T12:00:00Z\"\n }\n }\n\n","response":"HTTP 201 Created\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/60952048006/meeting/1486740858\",\n \"uuid\": \"GYjEo77LR/aXYJ0CVqsNfw==\",\n \"id\": \"1486740858\",\n \"topic\": \"My Recurring Meeting #1\",\n \"meetingType\": \"ScheduledRecurring\",\n \"password\": \"123456\",\n \"h323Password\": \"656888\",\n \"status\": \"NotStarted\",\n \"links\": {\n \"startUri\": \"https://meetings.ringcentral.com/s/1486740858?zpk=IzBfzZeo1ukkgikfoBMcJwkIeLa0-FodiqadY9SgnsM.BwcAAAFwmNNa9wAAHCAkNGUzMjBmODUtZmMyZS00ZmMwLTkxNzItNDFmMTY0ZjZiZjlhGGJldmlzLmx1QHJpbmdjZW50cmFsLmNvbRZmMUtMUlhZSlJvQ3diUWtLWUNSMjVBEUJldmlzIChKaW53ZWkpIEx1YgBmaGpSakpEbFA1ZXlNZ2o1UXdzeGhSaEUwWVVVVXpwN19SS2E5OGxnUFJ2US5CZ1FZVFdKdlNsaFpka1kzTDI1c1FXMWxlVmd5V2s1elVUMDlBQUFNTTBOQ1FYVnZhVmxUTTNNOUFBAAAIMzc0Mzk1MTAAAgEA\",\n \"joinUri\": \"https://meetings.ringcentral.com/j/1486740858?pwd=Q2VocXo3TS91N2Z0OTlidDJqM3BxUT09\"\n },\n \"host\": {\n \"uri\": \"http://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/60952048006\",\n \"id\": \"60952048006\"\n },\n \"allowJoinBeforeHost\": false,\n \"startHostVideo\": false,\n \"startParticipantsVideo\": true,\n \"audioOptions\": [\n \"Phone\",\n \"ComputerAudio\"\n ],\n \"usePersonalMeetingId\": false,\n \"occurrences\": [\n {\n \"id\": \"1583150400000\",\n \"startTime\": \"2020-03-02T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"status\": \"available\"\n },\n {\n \"id\": \"1583323200000\",\n \"startTime\": \"2020-03-04T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"status\": \"available\"\n },\n {\n \"id\": \"1583496000000\",\n \"startTime\": \"2020-03-06T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"status\": \"available\"\n },\n {\n \"id\": \"1583668800000\",\n \"startTime\": \"2020-03-08T12:00:00Z\",\n \"durationInMinutes\": 30,\n \"status\": \"available\"\n },\n {...}\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/user-settings":{"get":{"tags":["Meeting Configuration"],"summary":"Get Meeting User Settings","description":"Returns user settings for meetings.","operationId":"GetUserSetting","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: User Setting","content":{"application/json":{"schema":{"type":"object","properties":{"recording":{"type":"object","properties":{"localRecording":{"type":"boolean","description":"Allows hosts and participants to record a meeting to a local file"},"cloudRecording":{"type":"boolean","description":"Allows hosts to record and save a meeting/webinar in the cloud"},"recordSpeakerView":{"type":"boolean","description":"Allows to record active speaker with the shared screen","default":false},"recordGalleryView":{"type":"boolean","description":"Allows to record gallery view with the shared screen","default":false},"recordAudioFile":{"type":"boolean","description":"Allows to record an audio-only file","default":false},"saveChatText":{"type":"boolean","description":"Allows to save chat text from a meeting","default":false},"showTimestamp":{"type":"boolean","description":"Allows to show timestamp on video","default":false},"autoRecording":{"type":"string","description":"Automatical recording (local/cloud/none) of meetings as they start","default":"local","enum":["local","cloud","none"]},"autoDeleteCmr":{"type":"string","description":"Automatical deletion of cloud recordings","default":"false"},"autoDeleteCmrDays":{"type":"integer","description":"A specified number of days for automatical deletion of cloud recordings, the value range is 1-60"}},"description":"Meeting recording settings locked on account level"},"scheduleMeeting":{"type":"object","properties":{"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)"},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)"},"audioOptions":{"type":"array","description":"Determines how participants can join the audio channel of a meeting","items":{"type":"string","enum":["Phone","ComputerAudio","ThirdParty"]}},"allowJoinBeforeHost":{"type":"boolean","description":"Allows participants to join the meeting before the host arrives"},"usePmiForScheduledMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when scheduling a meeting"},"usePmiForInstantMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when starting an instant meeting"},"requirePasswordForSchedulingNewMeetings":{"type":"boolean","description":"A password will be generated when scheduling a meeting and participants will require password to join a meeting. The Personal Meeting ID (PMI) meetings are not included"},"requirePasswordForScheduledMeetings":{"type":"boolean","description":"Specifies whether to require a password for meetings which have already been scheduled"},"defaultPasswordForScheduledMeetings":{"type":"string","description":"Password for already scheduled meetings. Users can set it individually"},"requirePasswordForInstantMeetings":{"type":"boolean","description":"A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled"},"requirePasswordForPmiMeetings":{"type":"string","description":"Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only)","enum":["all","none","jbhOnly"]},"pmiPassword":{"type":"string","description":"The default password for Personal Meeting ID (PMI) meetings"},"pstnPasswordProtected":{"type":"boolean","description":"Specifies whether to generate and require a password for participants joining by phone"}},"description":"Scheduling meeting settings locked on account level || Settings defining how to schedule user meetingsxs"},"telephony":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"},"audioConferenceInfo":{"type":"boolean","description":"Users can join the meeting using the existing 3rd party audio configuration"}}}}}}}}},"x-api-group":"extension/meeting/user-settings","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/meeting/user-settings\n","response":"HTTP 200 OK\n\n{\n \"recording\": {\n \"localRecording\": true,\n \"cloudRecording\": true,\n \"recordSpeakerView\": true,\n \"recordGalleryView\": false,\n \"recordAudioFile\": true,\n \"saveChatText\": true,\n \"showTimestamp\": false,\n \"autoRecording\": \"none\",\n \"autoDeleteCmr\": false\n },\n \"scheduleMeeting\": {\n \"pstnPasswordProtected\": false,\n \"requirePasswordForSchedulingNewMeetings\": false,\n \"requirePasswordForScheduledMeetings\": false,\n \"requirePasswordForInstantMeetings\": false,\n \"requirePasswordForPmiMeetings\": \"none\",\n \"pmiPassword\": \"12345a\",\n \"startHostVideo\": false,\n \"startParticipantsVideo\": false,\n \"audioOptions\": [\n \"Phone\",\n \"ComputerAudio\"\n ],\n \"allowJoinBeforeHost\": false,\n \"usePmiForScheduledMeetings\": false,\n \"usePmiForInstantMeetings\": false\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/meeting/locked-settings":{"get":{"tags":["Meeting Configuration"],"summary":"Get Locked Meeting Settings","description":"Returns information on user meeting settings that are locked on account level and therefore cannot be changed by user.","operationId":"GetAccountLockedSetting","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of an account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Account Locked Meeting Settings","content":{"application/json":{"schema":{"type":"object","properties":{"scheduleMeeting":{"type":"object","properties":{"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)"},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)"},"audioOptions":{"type":"array","description":"Determines how participants can join the audio channel of a meeting","items":{"type":"string","enum":["Phone","ComputerAudio","ThirdParty"]}},"allowJoinBeforeHost":{"type":"boolean","description":"Allows participants to join the meeting before the host arrives"},"usePmiForScheduledMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when scheduling a meeting"},"usePmiForInstantMeetings":{"type":"boolean","description":"Determines whether to use Personal Meeting ID (PMI) when starting an instant meeting"},"requirePasswordForSchedulingNewMeetings":{"type":"boolean","description":"A password will be generated when scheduling a meeting and participants will require password to join a meeting. The Personal Meeting ID (PMI) meetings are not included"},"requirePasswordForScheduledMeetings":{"type":"boolean","description":"Specifies whether to require a password for meetings which have already been scheduled"},"defaultPasswordForScheduledMeetings":{"type":"string","description":"Password for already scheduled meetings. Users can set it individually"},"requirePasswordForInstantMeetings":{"type":"boolean","description":"A random password will be generated for an instant meeting, if set to 'True'. If you use PMI for your instant meetings, this option will be disabled"},"requirePasswordForPmiMeetings":{"type":"string","description":"Specifies whether to require a password for meetings using Personal Meeting ID (PMI). The supported values are: 'none', 'all' and 'jbhOnly' (joined before host only)","enum":["all","none","jbhOnly"]},"pmiPassword":{"type":"string","description":"The default password for Personal Meeting ID (PMI) meetings"},"pstnPasswordProtected":{"type":"boolean","description":"Specifies whether to generate and require a password for participants joining by phone"}},"description":"Scheduling meeting settings locked on account level || Settings defining how to schedule user meetingsxs"},"recording":{"type":"object","properties":{"localRecording":{"type":"boolean","description":"Allows hosts and participants to record a meeting to a local file"},"cloudRecording":{"type":"boolean","description":"Allows hosts to record and save a meeting/webinar in the cloud"},"recordSpeakerView":{"type":"boolean","description":"Allows to record active speaker with the shared screen","default":false},"recordGalleryView":{"type":"boolean","description":"Allows to record gallery view with the shared screen","default":false},"recordAudioFile":{"type":"boolean","description":"Allows to record an audio-only file","default":false},"saveChatText":{"type":"boolean","description":"Allows to save chat text from a meeting","default":false},"showTimestamp":{"type":"boolean","description":"Allows to show timestamp on video","default":false},"autoRecording":{"type":"string","description":"Automatical recording (local/cloud/none) of meetings as they start","default":"local","enum":["local","cloud","none"]},"autoDeleteCmr":{"type":"string","description":"Automatical deletion of cloud recordings","default":"false"},"autoDeleteCmrDays":{"type":"integer","description":"A specified number of days for automatical deletion of cloud recordings, the value range is 1-60"}},"description":"Meeting recording settings locked on account level"},"telephony":{"type":"object","properties":{"thirdPartyAudio":{"type":"boolean","description":"ThirdParty audio option"}}}}}}}}},"x-api-group":"account/meeting/locked-settings","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting-configuration/profile-image":{"post":{"tags":["Meeting Configuration"],"summary":"Upload User Meeting Profile Image","description":"Uploads profile picture for user meetings.","operationId":"createUserMeetingProfileImage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["profilePic"],"properties":{"profilePic":{"type":"string","description":"Profile image file size cannot exceed 2Mb. Supported formats are: JPG/JPEG, GIF and PNG","format":"file"}}}}}},"responses":{"204":{"description":"No Content"}},"x-api-group":"extension/user","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-request-max-body-size":"2m","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}":{"get":{"tags":["Meeting Management"],"summary":"Get Meeting Info","description":"Returns a particular meetings details by ID.","operationId":"readMeeting","parameters":[{"name":"meetingId","in":"path","description":"Internal identifier of a RingCentral meeting","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Meeting Info","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}}}}},"x-api-group":"extension/meeting","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/255537016/extension/255537016/meeting/1485321755\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1485321755\",\n \"id\" : \"1485321755\",\n \"topic\" : \"My meeting #1\",\n \"meetingType\" : \"Scheduled\",\n \"password\" : \"12345\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1485321755?zpk=vMDVJq6F4WQItdsc1MUu-jLO1uUxDk-xMurO19b9DRg.BwcAAAFmpYH3QAAAHCAkZDY3MTFjOTYtNmYwOS00Nzg3LTk5M2QtNjJjOThjM2YxZWVkGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-X2YxUEFfNjlRcWRzVFQ3cnBLNEtmQkx6T0oxNEVhMEpxM0c2RUJmTGJYMC5FZ0VBQUFGbXBZSDNRQUFBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1485321755?pwd=oeoDAU6FX1A\"\n },\n \"schedule\" : {\n \"startTime\" : \"2018-11-03T12:00:00Z\",\n \"durationInMinutes\" : 30,\n \"timeZone\" : {\n \"id\" : \"1\"\n }\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : true,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \n \"Phone\", \n \"ComputerAudio\" \n ],\n \"usePersonalMeetingId\": true,\n \"autoRecordType\": \"local\",\n \"muteParticipantsOnEntry\": true,\n \"enableWaitingRoom\": true,\n \"globalDialInCountries\": [\n \"US\",\n \"UK\",\n \"AU\"\n ]\n}\n"}],"x-error-codes":null},"put":{"tags":["Meeting Management"],"summary":"Update Meeting","description":"Modifies a particular meeting.","operationId":"updateMeeting","parameters":[{"name":"meetingId","in":"path","description":"Internal identifier of a RingCentral meeting","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"password":{"type":"string","description":"Meeting password"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","default":false},"startHostVideo":{"type":"boolean","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"usePersonalMeetingId":{"type":"boolean","description":"If true, then personal user's meeting ID is applied for creation of this meeting"},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"recurrence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}}},"required":false},"responses":{"200":{"description":"OK: Updated Meeting Info","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a meeting resource","format":"uri"},"uuid":{"type":"string","description":"Universally unique identifier of a meeting\""},"id":{"type":"string","description":"Internal identifier of a meeting"},"topic":{"type":"string","description":"Custom topic of a meeting"},"meetingType":{"type":"string","enum":["Instant","Scheduled","ScheduledRecurring","Recurring"]},"password":{"type":"string","description":"Meeting password"},"h323Password":{"type":"string"},"status":{"type":"string","description":"Status of a meeting"},"links":{"type":"object","properties":{"startUri":{"type":"string"},"joinUri":{"type":"string"}},"description":"Meeting links"},"schedule":{"type":"object","properties":{"startTime":{"type":"string"},"durationInMinutes":{"type":"integer","format":"int32"},"timeZone":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}}},"description":"Timing of a meeting"},"host":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the meeting host resource"},"id":{"type":"string","description":"Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier"}},"description":"Meeting host information"},"allowJoinBeforeHost":{"type":"boolean","description":"If true, then participants can join the meeting before host arrives","default":false},"startHostVideo":{"type":"boolean","description":"Starting meetings with host video on/off (true/false)","default":false},"startParticipantsVideo":{"type":"boolean","description":"Starting meetings with participant video on/off (true/false)","default":false},"audioOptions":{"type":"array","items":{"type":"string","enum":["Phone","ComputerAudio"]}},"reccurence":{"type":"object","properties":{"frequency":{"type":"string","description":"Recurrence time frame","enum":["Daily","Weekly","Monthly"]},"interval":{"type":"integer","description":"Reccurence interval. The supported ranges are: 1-90 for `Daily`; 1-12 for `Weekly`; 1-3 for `Monthly`"},"monthlyByWeek":{"type":"string","description":"Supported together with `weeklyByDay`","enum":["Last","First","Second","Third","Fourth"]},"weeklyByDay":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state which day in a month the meeting should recur. The value range is 1 - 31. For instance, if the meeting should recur each month on 23rd, provide `23` as the value of this field and `1` as the value of the recurrence `interval` field. And if the meeting should recur every three months, on 23rd of the month, change the value of the recurrence `interval` field to `3`.","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"weeklyByDays":{"type":"string","description":"This field is used only if you're scheduling a recurring meeting of type `2` to state which day(s) of the week the meeting should recur. The values are: 1 - Sunday; 2 - Monday; 3- Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7 - Saturday. Multiple values are supported, should be specified separated by comma","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]},"monthlyByDay":{"type":"integer","description":"The supported range is 1-31"},"monthlyByWeekDay":{"type":"integer","description":"This field is used only if you're scheduling a recurring meeting of type `3` to state a specific day in a week when the monthly meeting should recur; it works together with `MonthlyByWeek` field. The values are: 1 - Sunday; 2 - Monday; 3 - Tuesday; 4 - Wednesday; 5 - Thursday; 6 - Friday; 7- Saturday"},"count":{"type":"integer","description":"Number of meeting occurrences"},"until":{"type":"string","description":"Meeting expiration datetime"}},"description":"Meeting recurrence information"},"autoRecordType":{"type":"string","description":"Automatic record type","default":"none","enum":["local","cloud","none"]},"enforceLogin":{"type":"boolean","description":"If true, then only signed-in users can join this meeting"},"muteParticipantsOnEntry":{"type":"boolean","description":"If true, then participants are muted on entry"},"enableWaitingRoom":{"type":"boolean","description":"If true, then the waiting room for participants is enabled"},"globalDialInCountries":{"type":"array","description":"List of global dial-in countries (eg. US, UK, AU, etc.)","items":{"type":"string"}}}}}}}},"x-api-group":"extension/meeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"PUT /restapi/v1.0/account/255537016/extension/255537016/meeting/1490922120\n\n{\n \"topic\": \"My meeting\",\n \"meetingType\": \"Scheduled\",\n \"schedule\": {\n \"startTime\": \"2018-11-07T12:00:00Z\",\n \"durationInMinutes\": 60,\n \"timeZone\": {\"id\" : \"57\"}\n },\n \"host\" : {\n \"id\" : \"256440016\"},\n \"password\": \"123456\",\n \"allowJoinBeforeHost\": true,\n \"startHostVideo\": true,\n \"startParticipantsVideo\": true,\n \"audioOptions\": [\n \"Phone\",\n \"ComputerAudio\"\n ],\n \"usePersonalMeetingId\": true,\n \"autoRecordType\": \"local\",\n \"muteParticipantsOnEntry\": true,\n \"enableWaitingRoom\": true,\n \"globalDialInCountries\": [\n \"US\",\n \"UK\",\n \"AU\"\n ]\n} \n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/1490922120\",\n \"id\" : \"1490922120\",\n \"topic\" : \"My meeting\",\n \"meetingType\" : \"Scheduled\",\n \"password\" : \"123456\",\n \"status\" : \"NotStarted\",\n \"links\" : {\n \"startUri\" : \"https://meetings.ringcentral.com/s/1490922120?zpk=sBsvd4ivkz0Jdc8N7dOD5eCR9lG_cuOy2SdzOdM-rik.BwcAAAFmpZO-8wAAHCAkOGNjNThlMTQtNDM5OS00NzUwLWFkMzMtYzczNmY3ZmE2M2JmGnRlc3QrcGxhdGZvcm0rcG9kN0BkaW5zLnJ1FnJZWG1vVjFIUnhPaWdvb1FRR1VtOHcSUGxhdGZvcm0gVGVzdCBQT0Q3YgB-MU50c2liLTRweV9jcU5KRVN6cGp5ZEhvam5ja3REQlBoX2RDT1QtUUM5cy5FZ0VBQUFGbXBaTy04d0FBSENBZ1dWbEZUWG93UzFvMFZuWXdRVFZITHpkeWRWSm5RbTlqVDI5eWRpdHRlVFlBRERORFFrRjFiMmxaVXpOelBRAAAJMjU1NTM3MDE2AAIBAA\",\n \"joinUri\" : \"https://meetings.ringcentral.com/j/1490922120?pwd=tWzAHHXJzXQ\"\n },\n \"schedule\" : {\n \"startTime\" : \"2018-11-07T12:00:00Z\",\n \"durationInMinutes\" : 60,\n \"timeZone\" : {\n \"id\" : \"57\"\n }\n },\n \"host\" : {\n \"id\" : \"255537016\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016\"\n },\n \"allowJoinBeforeHost\" : true,\n \"startHostVideo\" : true,\n \"startParticipantsVideo\" : true,\n \"audioOptions\" : [ \n \"Phone\", \n \"ComputerAudio\" \n ],\n \"usePersonalMeetingId\": true,\n \"autoRecordType\": \"local\",\n \"muteParticipantsOnEntry\": true,\n \"enableWaitingRoom\": true,\n \"globalDialInCountries\": [\n \"US\",\n \"UK\",\n \"AU\"\n ]\n} \n\n"}],"x-error-codes":null},"delete":{"tags":["Meeting Management"],"summary":"Delete Meeting","description":"Deletes a scheduled meeting.","operationId":"deleteMeeting","parameters":[{"name":"meetingId","in":"path","description":"Internal identifier of a RingCentral meeting","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/meeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"EditMeetings","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/account/402946441008/extension/402946441008/meeting/1492807401\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end":{"post":{"tags":["Meeting Management"],"summary":"End Meeting","description":"Ends a meetings which is in progress.","operationId":"endMeeting","parameters":[{"name":"meetingId","in":"path","description":"Internal identifier of a RingCentral meeting","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/meeting/end","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"EditMeetings","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/account/403784066008/extension/403784066008/meeting/1486579931/end\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info":{"get":{"tags":["Meeting Configuration"],"summary":"Get Meeting Service Info","description":"Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information.","operationId":"readMeetingServiceInfo","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Meeting Service Info","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"supportUri":{"type":"string"},"intlDialInNumbersUri":{"type":"string"},"externalUserInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}},"dialInNumbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"formattedNumber":{"type":"string"},"location":{"type":"string"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}}}}}}}}}}},"x-api-group":"extension/meeting/service-info","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-docs-level":"Public","x-feature":"Meetings","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/255537016/extension/255537016/meeting/service-info\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/service-info\",\n \"supportUri\" : \"http://success.ringcentral.com\",\n \"intlDialInNumbersUri\" : \"https://meetings.ringcentral.com/teleconference\",\n \"externalUserInfo\" : {\n uri: \"https://meetings.ringcentral.com/externalUserInfo\",\n \"userId\" : \"rYXmoV1HRxOigooQQGUm8w\",\n \"accountId\" : \"255537016\",\n \"userType\" : 2,\n \"userToken\" : \"ohjpHs3O5AmGxdQAs3lee0_qWB9bCqPhiKDrrVTZDyQ.CAIAAAFmpdEIewAAAHgYanE4VEpwUUJ5MEUwVTQxOVJJSHZOdz09DDNDQkF1b2lZUzNzPQ\",\n \"hostKey\" : \"994222\",\n \"personalMeetingId\": \"string\",\n \"usePmiForInstantMeetings\": true\n \"personalLink\": \"https://meetings.ringcentral.com/my/jsmith\"\n },\n \"dialInNumbers\" : [ {\n \"phoneNumber\" : \"+35314870050\",\n \"formattedNumber\" : \"(01) 487 0050\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/107\",\n \"id\" : \"107\",\n \"name\" : \"Ireland\",\n \"isoCode\" : \"IE\",\n \"callingCode\" : \"353\"\n }\n } ],\n \"domain\" : \"ringcentral.com\"\n}\n"}],"x-error-codes":null},"patch":{"tags":["Meeting Configuration"],"summary":"Update Meeting Service Info","description":"Updates personal meeting identifier.","operationId":"updateMeetingServiceInfo","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"externalUserInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}}}}}},"required":true},"responses":{"200":{"description":"OK: Meeting Service Info","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"supportUri":{"type":"string"},"intlDialInNumbersUri":{"type":"string"},"externalUserInfo":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"userId":{"type":"string"},"accountId":{"type":"string"},"userType":{"type":"integer","format":"int64"},"userToken":{"type":"string"},"hostKey":{"type":"string"},"personalMeetingId":{"type":"string"},"personalLink":{"type":"string","description":"Link to the user's personal meeting room, used as an alias for personal meeting URL (with personal meeting ID)","example":"https://meetings.ringcentral.com/my/jsmith"},"usePmiForInstantMeetings":{"type":"boolean","description":"Enables using personal meeting ID for instant meetings","default":false}}},"dialInNumbers":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string"},"formattedNumber":{"type":"string"},"location":{"type":"string"},"country":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"},"name":{"type":"string"},"isoCode":{"type":"string"},"callingCode":{"type":"string"},"emergencyCalling":{"type":"boolean","default":false},"numberSelling":{"type":"boolean","default":false},"loginAllowed":{"type":"boolean","default":false}}}}}}}}}}}},"x-api-group":"extension/meeting/service-info","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-docs-level":"Public","x-feature":"EditMeetings","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"PATCH /restapi/v1.0/account/~/extension/~/meeting/service-info\n\n{\n \"externalUserInfo\" : {\n \"personalMeetingId\": \"2035134243\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/255537016/extension/255537016/meeting/service-info\",\n \"supportUri\" : \"http://success.ringcentral.com\",\n \"intlDialInNumbersUri\" : \"https://meetings.ringcentral.com/teleconference\",\n \"externalUserInfo\" : {\n \"userId\" : \"rYXmoV1HRxOigooQQGUm8w\",\n \"accountId\" : \"255537016\",\n \"userType\" : 2,\n \"userToken\" : \"ohjpHs3O5AmGxdQAs3lee0_qWB9bCqPhiKDrrVTZDyQ.CAIAAAFmpdEIewAAAHgYanE4VEpwUUJ5MEUwVTQxOVJJSHZOdz09DDNDQkF1b2lZUzNzPQ\",\n \"hostKey\" : \"994222\",\n \"personalMeetingId\": \"2035134243\"\n },\n \"dialInNumbers\" : [ ... ],\n \"domain\" : \"ringcentral.com\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assistants":{"get":{"tags":["Meeting Configuration"],"summary":"Get Assistants","description":"Returns assistants information.","operationId":"readAssistants","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Assistants Info","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"x-api-group":"extension/meeting/assistant-info","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assisted":{"get":{"tags":["Meeting Configuration"],"summary":"Get Assisted Users","description":"Returns assisted users information.","operationId":"readAssistedUsers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Assisted User Info","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"x-api-group":"extension/meeting/assistant-info","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-feature":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/invitation":{"get":{"tags":["Meeting Management"],"summary":"Get Meeting Invitation","description":"Returns a meeting invitation by ID.","operationId":"readMeetingInvitation","parameters":[{"name":"meetingId","in":"path","description":"Internal identifier of a RingCentral meeting","required":true,"schema":{"type":"integer"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of an account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK: Meeting Invitation","content":{"application/json":{"schema":{"type":"object","properties":{"invitation":{"type":"string","description":"Meeting invitation"}}}}}}},"x-api-group":"extension/meeting","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"Meetings","x-docs-level":"Public","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/subscription":{"get":{"tags":["Subscriptions"],"summary":"Get Subscription List","description":"Returns the list of subscriptions created by the logged-in user for the currently authorized client application.","operationId":"listSubscriptions","responses":{"200":{"description":"List of Subscriptions","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"records":{"type":"array","items":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}}}}}},"x-api-group":"subscription","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/subscription\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription/eb709175-74a0-4099-883e-f7b93db872cd\",\n \"id\" : \"eb709175-74a0-4099-883e-f7b93db872cd\",\n \"creationTime\" : \"2016-04-03T11:16:19.407Z\",\n \"status\" : \"Active\",\n \"eventFilters\" : [ \"/restapi/v1.0/account/401094081008/extension/401094081008/incoming-call-pickup\",\n \"/restapi/v1.0/account/401094081008/extension/401094081008/message-store\" ],\n \"expirationTime\" : \"2016-05-03T11:16:19.410Z\",\n \"expiresIn\" : 2591427,\n \"deliveryMode\" : {\n \"transportType\" : \"RC/APNS\",\n \"encryption\" : false,\n \"address\" : \"1039185327791820_25067690\",\n \"subscriberKey\" : \"sub-c-a41b24aa-65ca-11e5-9c7c-0619f8945a4f\",\n \"registrationId\" : \"d30414dce391bbdf111f7b30e0e61444494acac555c21b38debbbb3ebe887fc0\",\n \"certificateName\" : \"com.ringcentral.RingCentralMobile\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription/29a57435-535b-457b-a265-bb52311ac7da\",\n \"id\" : \"29a57435-535b-457b-a265-bb52311ac7da\",\n \"creationTime\" : \"2016-04-03T11:16:03.563Z\",\n \"status\" : \"Active\",\n \"eventFilters\" : [ \"/restapi/v1.0/account/401094081008/extension/401094081008/presence\" ],\n \"expirationTime\" : \"2016-04-03T11:31:03.810Z\",\n \"expiresIn\" : 312,\n \"deliveryMode\" : {\n \"transportType\" : \"PubNub\",\n \"encryption\" : true,\n \"address\" : \"1039169654747671_e12d4948\",\n \"subscriberKey\" : \"sub-c-b8b9cd8c-e906-11e2-b383-02ee2ddab7fe\",\n \"encryptionAlgorithm\" : \"AES\",\n \"encryptionKey\" : \"lWtIUyDQfLuiXTLu1pcI2Q==\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription/e7a9e696-08c5-4937-a0e1-06b37995eca8\",\n \"id\" : \"e7a9e696-08c5-4937-a0e1-06b37995eca8\",\n \"creationTime\" : \"2016-04-03T11:16:25.142Z\",\n \"status\" : \"Active\",\n \"eventFilters\" : [ \"/restapi/v1.0/account/401094081008/extension/401094081008/presence\", \n \"/restapi/v1.0/account/401094081008/extension/401094081008/message-store\" ],\n \"expirationTime\" : \"2016-04-10T11:16:25.161Z\",\n \"expiresIn\" : 604233,\n \"deliveryMode\" : {\n \"transportType\" : \"WebHook\",\n \"encryption\" : false,\n \"address\" : \"https://consumer-host.example.com/consumer/path\"\n }\n } ]\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-165","message":"null"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"},{"httpCode":"503","errorCode":"CMN-201","message":"Service Temporary Unavailable"}]},"post":{"tags":["Subscriptions"],"summary":"Create Subscription","description":"Creates a new subscription.","operationId":"createSubscription","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["deliveryMode","eventFilters"],"type":"object","properties":{"eventFilters":{"type":"array","description":"Collection of URIs to API resources","items":{"type":"string"}},"deliveryMode":{"type":"object","properties":{"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"address":{"type":"string","description":"Mandatory for 'WebHook' transport type, URL of a consumer service (cannot be changed during subscription update)"},"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False'"},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"verificationToken":{"type":"string","description":"Verification key of a subscription ensuring data security. Supported for 'Webhook' transport type"}},"description":"Notification delivery settings"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years)"}}}}},"required":true},"responses":{"200":{"description":"Created Subscription","content":{"application/json":{"schema":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}}},"x-api-group":"subscription","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"PubNub","request":"POST /restapi/v1.0/subscription\n\n{\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/~/presence?detailedTelephonyState=true\"\n ],\n \"deliveryMode\": {\n \"transportType\": \"PubNub\",\n \"encryption\": \"true\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription/ed329ec1-0600-4560-b6dc-c764399e9a54\",\n \"id\" : \"ed329ec1-0600-4560-b6dc-c764399e9a54\",\n \"creationTime\" : \"2016-02-17T15:41:45.601Z\",\n \"status\" : \"Active\",\n \"eventFilters\" : [ \"/restapi/v1.0/account/2021383004/extension/2021383004/presence?detailedTelephonyState=true\" ],\n \"expirationTime\" : \"2016-02-17T15:56:45.617Z\",\n \"expiresIn\" : 899,\n \"deliveryMode\" : {\n \"transportType\" : \"PubNub\",\n \"encryption\" : true,\n \"address\" : \"54770517599294_6dda849e\",\n \"subscriberKey\" : \"sub-c-b8b9cd8c-e906-11e2-b383-02ee2ddab7fe\",\n \"encryptionAlgorithm\" : \"AES\",\n \"encryptionKey\" : \"0mWk/6SMiSz191u2dV5drg==\"\n }\n}\n"},{"title":"WebHook","request":"POST /restapi/v1.0/subscription\n\n{\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/~/presence\",\n \"/restapi/v1.0/account/~/extension/~/message-store\"\n ],\n \"deliveryMode\": {\n \"transportType\": \"WebHook\",\n \"address\": \"https://consumer-host.example.com/consumer/path\"\n }\n}\n","response":"HTTP 200 OK\n\n {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/subscription/dd2f0ff2-580e-4581-a277-76f9c9a54bc9\",\n \"id\" : \"dd2f0ff2-580e-4581-a277-76f9c9a54bc9\",\n \"creationTime\" : \"2016-03-30T11:16:23.162Z\",\n \"status\" : \"Active\",\n \"eventFilters\" : [ \"/restapi/v1.0/account/10366034004/extension/10366034004/presence\", \n \"/restapi/v1.0/account/10366034004/extension/10366034004/message-store\"],\n \"expirationTime\" : \"2016-04-06T11:16:23.177Z\",\n \"expiresIn\" : 604799,\n \"deliveryMode\" : {\n \"transportType\" : \"WebHook\",\n \"encryption\" : false,\n \"address\" : \"https://consumer-host.example.com/consumer/path\"\n }\n }\n\n"},{"title":"RC/APNS","request":"{\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/~/start-ring\"\n ],\n \"deliveryMode\": {\n \"transportType\": \"RC/APNS\",\n \"registrationId\": \"d30414dce391bbdf111f7b30e0e61444494acac555c21b38debbbb3ebe887fc0\",\n \"certificateName\": \"com.ringcentral.RingCentralMobile\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/subscription/cd863000-6b3c-4557-bd14-92ab75f92564\", \n \"id\": \"cd863000-6b3c-4557-bd14-92ab75f92564\",\n \"creationTime\": \"2019-10-10T07:34:26.419Z\",\n \"status\": \"Active\",\n \"eventFilters\": [\n \"/restapi/v1.0/account/12535590004/extension/12535594004/presence/line/presence?detailedTelephonyState=true&sipData=true\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/missed-calls\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/message-store\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/presence/line\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/inbound-messages?badge=true\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/stop-ring\",\n \"/restapi/v1.0/account/12535590004/extension/12535594004/presence?detailedTelephonyState=true&sipData=true\"\n ],\n \"expirationTime\": \"2019-11-09T07:34:26.419Z\",\n \"expiresIn\": 2591999,\n \"deliveryMode\": {\n \"transportType\": \"RC/APNS\",\n \"encryption\": false,\n \"registrationId\": \"5de333a6009313b3b8edaad0fa35a88940784485577f5bb90e028bcb60233123\",\n \"certificateName\": \"com.ringcentral.RingCentralMobile/dev/regular\"\n }\n}\n\n"},{"title":"RC/GCM","request":"{\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/~/start-ring\"\n ],\n \"deliveryMode\": {\n \"transportType\": \"RC/GCM\",\n \"registrationId\": \"d30414dce391bbdf111f7b30e0e61444494acac555c21b38debbbb3ebe887fc0\",\n \"certificateName\": \"com.ringcentral.android\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n\n \"uri\":\"https://platform.ringcentral.com/restapi/v1.0/subscription/26126e50-71d6-4443-9e73-7b896f07bf28\", \"id\":\"26126e50-71d6-4443-9e73-7b896f07bf28\",\n \"creationTime\":\"2019-10-11T07:17:28.169Z\",\n \"status\":\"Active\",\n \"eventFilters\":[\n \"/restapi/v1.0/account/12648940004/extension/12648944004/inbound-messages?badge=true\"\n ],\n \"expirationTime\":\"2019-11-10T07:17:28.169Z\",\n \"expiresIn\":2591999,\n \"deliveryMode\":{\n \"transportType\":\"RC/GCM\",\n \"encryption\":false,\n \"registrationId\":\"fqkdRqSDh7QAPA91bFa639D4OaWfYUqipXfThMAcZYwUkZz0VtkPNId6Qbe6s8xG_PMuRur9R_Kat9k7sRVgeOSX0QJVeS990c2N7kBx5_DAbw4yTkn8durUdc_XNKi1BunHdwG6T99V1K9lRde9R3m\",\n \"certificateName\":\"com.ringcentral.android/regular\"; \n }\n}\n\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"400","errorCode":"SUB-516","message":"Invalid reminder parameters"},{"httpCode":"400","errorCode":"SUB-520","message":"Validation Token is not returned"},{"httpCode":"400","errorCode":"SUB-521","message":"WebHook is not reachable"},{"httpCode":"400","errorCode":"SUB-523","message":"HTTPS is required"},{"httpCode":"400","errorCode":"SUB-525","message":"WebHook server response is invalid"},{"httpCode":"401","errorCode":"CMN-405","message":"null"},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-165","message":"null"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"403","errorCode":"SUB-406","message":"Not allowed subscribe for events to extensions of other account"},{"httpCode":"403","errorCode":"SUB-505","message":"Subscriptions limit exceeded"},{"httpCode":"403","errorCode":"SUB-527","message":"Not allowed subscribe for missed calls of another extension"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"},{"httpCode":"429","errorCode":"CMN-302","message":"Request rate exceeded"},{"httpCode":"503","errorCode":"CMN-201","message":"Service Temporary Unavailable"}]}},"/restapi/v1.0/subscription/{subscriptionId}":{"get":{"tags":["Subscriptions"],"summary":"Get Subscription","description":"Returns the requested subscription by ID.","operationId":"readSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"Internal identifier of a subscription","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Existing Subscription","content":{"application/json":{"schema":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}}},"x-api-group":"subscription","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/subscription/60ce3d67-9104-478c-bcb3-768d93c0151c\n","response":"HTTP 200 OK\n\n{\n \"id\": \"60ce3d67-9104-478c-bcb3-768d93c0151c\",\n \"creationTime\": \"2018-08-20T06:07:04.614Z\",\n \"status\": \"Active\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/subscription/60ce3d67-9104-478c-bcb3-768d93c0151c\",\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/400700290004/presence?detailedTelephonyState=true\"\n ],\n \"disabledFilters\": [ {\n \"filter\": \"/restapi/v1.0/account/1460156004/extension/1460172004/presence/line\",\n \"reason\": \"SUB-412\",\n \"message\": \"Extension permission [HUD] is missing\"\n }],\n \"expirationTime\": \"2018-08-20T06:22:04.614Z\",\n \"expiresIn\": 687,\n \"deliveryMode\": {\n \"transportType\": \"PubNub\",\n \"encryption\": true,\n \"address\": \"410843294189492_7777a1d1\",\n \"subscriberKey\": \"sub-c-b8b9cd8c-e906-11e2-b383-02ee2ddab7fe\",\n \"encryptionAlgorithm\": \"AES\",\n \"encryptionKey\": \"/boiP9IObgz6mrDalnl5lA==\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"404","errorCode":"CMN-120","message":"Invalid URI"}]},"put":{"tags":["Subscriptions"],"summary":"Update Subscription","description":"Updates the existent subscription. The client application can extend/narrow the events for which it receives notifications within the frame of one subscription. If event filters are specified, calling this method modifies them for the existing subscription. The method also allows to set the subscription expiration time. If other than `events` and `expiresIn` parameters are passed in request they will be ignored. If the request body is empty then the specified subscription will be just renewed without any event filter change and with expiration time default.","operationId":"updateSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"Internal identifier of a subscription","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["eventFilters"],"type":"object","properties":{"eventFilters":{"type":"array","description":"Collection of URIs to API resources","items":{"type":"string"}},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years)"}}}}},"required":true},"responses":{"200":{"description":"Updated Subscription","content":{"application/json":{"schema":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}}},"x-api-group":"subscription","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/subscription/2391578d-cb19-45dc-b3cd-9553ac428d24\n\n{\n \"eventFilters\": [\n \"/restapi/v1.0/account/~/extension/~/presence?detailedTelephonyState=true\",\n \"/restapi/v1.0/account/~/extension/~/message-store\"\n ],\n \"expiresIn\": 2591999\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/subscription/2391578d-cb19-45dc-b3cd-9553ac428d24\",\n \"id\": \"2391578d-cb19-45dc-b3cd-9553ac428d24\",\n \"creationTime\": \"2018-10-29T15:40:10.439Z\",\n \"status\": \"Active\",\n \"eventFilters\": [\n \"/restapi/v1.0/account/255537016/extension/255537016/presence?detailedTelephonyState=true\",\n \"/restapi/v1.0/account/255537016/extension/255537016/message-store\"\n ],\n \"expirationTime\": \"2018-11-30T10:56:43.784Z\",\n \"expiresIn\": 2591999,\n \"deliveryMode\": {\n \"transportType\": \"PubNub\",\n \"encryption\": false,\n \"address\": \"1757739837754172_537c087c\",\n \"subscriberKey\": \"sub-c-a41b24aa-65ca-11e5-9c7c-0619f8945a4f\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"401","errorCode":"CMN-405","message":"null"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-165","message":"null"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"403","errorCode":"SUB-406","message":"Not allowed subscribe for events to extensions of other account"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"},{"httpCode":"429","errorCode":"CMN-302","message":"Request rate exceeded"}]},"delete":{"tags":["Subscriptions"],"summary":"Cancel Subscription","description":"Cancels the existent subscription.","operationId":"deleteSubscription","parameters":[{"name":"subscriptionId","in":"path","description":"Internal identifier of a subscription","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"subscription","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/subscription/2391578d-cb19-45dc-b3cd-9553ac428d24\n","response":"HTTP 204 No Content\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"401","errorCode":"CMN-405","message":"null"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/subscription/{subscriptionId}/renew":{"post":{"tags":["Subscriptions"],"summary":"Renew Subscription","description":"Renews an existent subscription by posting request with an empty body.","operationId":"renewSubscription","parameters":[{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Renewed Subscription","content":{"application/json":{"schema":{"required":["deliveryMode"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a subscription"},"uri":{"type":"string","description":"Canonical URI of a subscription"},"eventFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to","items":{"type":"string"}},"disabledFilters":{"type":"array","description":"Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations","items":{"type":"object","properties":{"filter":{"type":"string","description":"Event filter that is disabled for the user"},"reason":{"type":"string","description":"Reason why the filter is disabled for the user"},"message":{"type":"string","description":"Error message"}}}},"expirationTime":{"type":"string","description":"Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"expiresIn":{"type":"integer","description":"Subscription lifetime in seconds"},"status":{"type":"string","description":"Subscription status","enum":["Active","Suspended","Blacklisted"]},"creationTime":{"type":"string","description":"Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"deliveryMode":{"type":"object","properties":{"encryption":{"type":"boolean","description":"Optional parameter. Specifies if the message will be encrypted or not"},"address":{"type":"string","description":"PubNub channel name"},"subscriberKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel"},"secretKey":{"type":"string","description":"PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only)"},"encryptionAlgorithm":{"type":"string","description":"Encryption algorithm 'AES' (for PubNub transport type only)"},"encryptionKey":{"type":"string","description":"Key for notification message decryption (for PubNub transport type only)"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}},"description":"Delivery mode data"},"blacklistedData":{"type":"object","properties":{"blacklistedAt":{"type":"string","description":"Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*","format":"date-time"},"reason":{"type":"string","description":"Reason for adding subscrition to a black list"}},"description":"Returned if WebHook subscription is blacklisted"},"transportType":{"type":"string","description":"Notifications transportation provider name","enum":["PubNub","WebHook","RC/APNS","RC/GCM"]},"certificateName":{"type":"string","description":"Name of a certificate. Supported for 'RC/APNS' and 'RC/GCM' transport types"},"registrationId":{"type":"string","description":"Identifier of a registration. Supported for 'RC/APNS' and 'RC/GCM' transport types"}}}}}}},"x-api-group":"subscription","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-http-examples":[{"request":"POST /restapi/v1.0/subscription/2391578d-cb19-45dc-b3cd-9553ac428d24/renew \n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/subscription/2391578d-cb19-45dc-b3cd-9553ac428d24\",\n \"id\": \"2391578d-cb19-45dc-b3cd-9553ac428d24\",\n \"creationTime\": \"2018-10-29T15:40:10.439Z\",\n \"status\": \"Active\",\n \"eventFilters\": [\n \"/restapi/v1.0/account/255537016/extension/255537016/presence?detailedTelephonyState=true\",\n \"/restapi/v1.0/account/255537016/extension/255537016/message-store\"\n ],\n \"expirationTime\": \"2018-11-30T10:49:22.711Z\",\n \"expiresIn\": 2591999,\n \"deliveryMode\": {\n \"transportType\": \"RC/APNS\",\n \"encryption\": false,\n \"address\": \"1757739837754172_537c087c\",\n \"subscriberKey\": \"sub-c-a41b24aa-65ca-11e5-9c7c-0619f8945a4f\",\n \"registrationId\": \"d30414dce391bbdf111f7b30e0e61444494acac555c21b38debbbb3ebe887fc0\",\n \"certificateName\": \"com.ringcentral.RingCentralMobile\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"401","errorCode":"CMN-405","message":"null"},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-165","message":"null"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile":{"get":{"tags":["User Permissions"],"summary":"Get Authorization Profile","description":"Returns a list of user permissions granted at authorization procedure. Please note: Some permissions may be restricted by extension type.","operationId":"readAuthorizationProfile","parameters":[{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"permissions":{"type":"array","items":{"type":"object","properties":{"permission":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"effectiveRole":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["Account","AllExtensions","Federation","NonUserExtensions","RoleBased","Self","UserExtensions"]}}}}}}}}}}},"x-api-group":"extension/authz-profile","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/authz-profile\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401172177008/extension/401172177008/authz-profile\",\n \"permissions\" : [ {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/AccountAdministration\",\n \"id\" : \"AccountAdministration\"\n },\n \"scopes\" : [ \"Account\" ]\n }, {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/AccountValidation\",\n \"id\" : \"AccountValidation\"\n },\n \"scopes\" : [ \"Account\" ]\n }, {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/ActiveDirectory\",\n \"id\" : \"ActiveDirectory\"\n },\n \"scopes\" : [ \"Account\" ]\n }, {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/AddRemoveDevices\",\n \"id\" : \"AddRemoveDevices\"\n },\n \"scopes\" : [ \"Account\" ]\n }, {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/AddRemoveGroups\",\n \"id\" : \"AddRemoveGroups\"\n },\n \"scopes\" : [ \"NonUserExtensions\" ]\n }, \n {...}\n ]\n\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-404","message":"Attempt to access another extension"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [extensionId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check":{"get":{"tags":["User Permissions"],"summary":"Check User Permission","description":"Checks if a certain user permission is activated for a particular extension.","operationId":"checkUserPermission","parameters":[{"name":"permissionId","in":"query","schema":{"type":"string"}},{"name":"targetExtensionId","in":"query","schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Authorization Profile Resource","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"successful":{"type":"boolean","default":false},"details":{"type":"object","properties":{"permission":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string"},"siteCompatible":{"type":"string","description":"Site compatibility flag set for permission","enum":["Compatible","Incompatible","Independent"]},"readOnly":{"type":"boolean","description":"Specifies if the permission is editable on UI (if set to 'True') or not (if set to 'False')"},"assignable":{"type":"boolean","description":"Specifies if the permission can be assigned by the account administrator"}}},"effectiveRole":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"id":{"type":"string"}}},"scopes":{"type":"array","items":{"type":"string","enum":["Account","AllExtensions","Federation","NonUserExtensions","RoleBased","Self","UserExtensions"]}}}}}}}}}},"x-api-group":"extension/authz-profile/check","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/authz-profile/check?permissionId=ReadMessages&targetExtensionId=401172186008\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401172177008/extension/401172177008/authz-profile/check?permissionId=ReadMessages&targetExtensionId=401172186008\",\n \"successful\" : true,\n \"details\" : {\n \"permission\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/ReadMessages\",\n \"id\" : \"ReadMessages\"\n },\n \"scopes\" : [ \"AllExtensions\" ]\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [targetExtensionId] value is invalid."},{"httpCode":"403","errorCode":"CMN-404","message":"Attempt to access another extension"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [extensionId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours":{"get":{"tags":["Business Hours"],"summary":"Get User Business Hours","description":"Returns the user business hours schedule. Business hours (and After hours - all the remaining time) schedules are commonly used for setting call handling rules - `business-hours-rule` and `after-hours-rule` correspondingly. **Please note:** If the user business hours are set to 'Custom hours' then a particular schedule is returned; however if set to '24 hours/7 days a week' the schedule will be empty.","operationId":"readUserBusinessHours","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"uri":"https.../restapi/v1.0/account/401800045008/extension/401800045008/business-hours","schedule":{"weeklyRanges":{"wednesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"tuesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}]}}}}}}}},"x-api-group":"extension/business-hours","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Custom hours","request":"GET /restapi/v1.0/account/37439510/extension/~/business-hours\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/business-hours\",\n \"schedule\" : {\n \"weeklyRanges\" : {\n \"monday\" : [ {\n \"from\" : \"10:00\",\n \"to\" : \"18:00\"\n } ],\n \"tuesday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"wednesday\" : [ {\n \"from\" : \"15:00\",\n \"to\" : \"18:00\"\n } ],\n \"thursday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"friday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"17:00\"\n } ]\n }\n }\n}\n\n"},{"title":"24 hours/7 days a week","request":"GET /restapi/v1.0/account/37439510/extension/~/business-hours\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/business-hours\",\n \"schedule\" : { }\n}\n\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]},"put":{"tags":["Business Hours"],"summary":"Update User Business Hours","description":"Updates the user business hours schedule.","operationId":"updateUserBusinessHours","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}}}}}}},"x-api-group":"extension/business-hours","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/business-hours\n\n{\n \"schedule\": {\n \"weeklyRanges\": {\n \"tuesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"friday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"thursday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"wednesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"monday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ]\n }\n }\n} \n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/13328820004/extension/13328820004/business-hours\",\n \"schedule\" : {\n \"weeklyRanges\" : {\n \"monday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"tuesday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"wednesday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"thursday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ],\n \"friday\" : [ {\n \"from\" : \"09:00\",\n \"to\" : \"18:00\"\n } ]\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"}]}},"/restapi/v1.0/account/{accountId}/business-hours":{"get":{"tags":["Business Hours"],"summary":"Get Company Business Hours","description":"Returns the company business hours schedule. Business hours (and After hours - all the remaining time) schedules are commonly used for setting call handling rules - `business-hours-rule` and `after-hours-rule` correspondingly.","operationId":"readCompanyBusinessHours","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource "},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"uri":"https.../restapi/v1.0/account/401800045008/business-hours","schedule":{"weeklyRanges":{"wednesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"tuesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}]}}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserAnsweringRules","x-feature":"ReadExtensionAnsweringRules","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401800045008/business-hours\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401800045008/business-hours\",\n \"schedule\": {\n \"weeklyRanges\": {\n \"wednesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"friday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"sunday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"saturday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"tuesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"monday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"thursday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ]\n }\n }\n}\n"}],"x-error-codes":null},"put":{"tags":["Business Hours"],"summary":"Update Company Business Hours","description":"Updates the company business hours schedule.","operationId":"updateCompanyBusinessHours","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"schedule":{"weeklyRanges":{"tuesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}],"wednesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}]}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a business-hours resource "},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"}},"description":"Schedule when an answering rule is applied"}},"example":{"uri":"https.../restapi/v1.0/account/401800045008/business-hours","schedule":{"weeklyRanges":{"wednesday":[{"from":"09:00","to":"18:00"}],"friday":[{"from":"09:00","to":"18:00"}],"tuesday":[{"from":"09:00","to":"18:00"}],"monday":[{"from":"09:00","to":"18:00"}],"thursday":[{"from":"09:00","to":"18:00"}]}}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/business-hours\n\n{\n \"schedule\": {\n \"weeklyRanges\": {\n \"wednesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"friday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"sunday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"saturday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"tuesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"monday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"thursday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ]\n }\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401800045008/business-hours\",\n \"schedule\": {\n \"weeklyRanges\": {\n \"wednesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"friday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"sunday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"saturday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"tuesday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"monday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ],\n \"thursday\": [\n {\n \"from\": \"09:00\",\n \"to\": \"18:00\"\n }\n ]\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking":{"get":{"tags":["Call Blocking"],"summary":"Get Caller Blocking Settings","description":"Returns the current caller blocking settings of a user.","operationId":"readCallerBlockingSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","description":"Call blocking options: either specific or all calls and faxes","enum":["Specific","All"]},"noCallerId":{"type":"string","description":" Determines how to handle calls with no caller ID in 'Specific' mode","enum":["BlockCallsAndFaxes","BlockFaxes","Allow"]},"payPhones":{"type":"string","description":"Blocking settings for pay phones","enum":["Block","Allow"]},"greetings":{"type":"array","description":"List of greetings played for blocked callers","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}}}},"description":"Returns the lists of blocked and allowed phone numbers"}}}}},"x-api-group":"extension/caller-blocking","x-throttling-group":"Light","x-app-permission":"ReadAccounts","x-user-permission":"ReadBlockedNumbers","x-feature":"ReadBlockedNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/caller-blocking\n","response":"HTTP 200 OK\n\n{\n \"mode\": \"Specific\",\n \"noCallerId\": \"Allow\",\n \"payPhones\": \"Block\",\n \"greetings\": [\n {\n \"type\": \"BlockedCallersAll\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398593\",\n \"id\": \"398593\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedNoCallerId\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398849\",\n \"id\": \"398849\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedPayPhones\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/399105\",\n \"id\": \"399105\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedCallersSpecific\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398337\",\n \"id\": \"398337\",\n \"name\": \"Blocked\"\n }\n }\n ]\n}\n"}],"x-error-codes":null},"put":{"tags":["Call Blocking"],"summary":"Update Caller Blocking Settings","description":"Updates the current caller blocking settings of a user.","operationId":"updateCallerBlockingSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","description":"Call blocking options: either specific or all calls and faxes","enum":["Specific","All"]},"noCallerId":{"type":"string","description":"Determines how to handle calls with no caller ID in 'Specific' mode","enum":["BlockCallsAndFaxes","BlockFaxes","Allow"]},"payPhones":{"type":"string","description":"Blocking settings for pay phones","enum":["Block","Allow"]},"greetings":{"type":"array","description":"List of greetings played for blocked callers","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}}}},"description":"Returns the lists of blocked and allowed phone numbers"}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mode":{"type":"string","description":"Call blocking options: either specific or all calls and faxes","enum":["Specific","All"]},"noCallerId":{"type":"string","description":" Determines how to handle calls with no caller ID in 'Specific' mode","enum":["BlockCallsAndFaxes","BlockFaxes","Allow"]},"payPhones":{"type":"string","description":"Blocking settings for pay phones","enum":["Block","Allow"]},"greetings":{"type":"array","description":"List of greetings played for blocked callers","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting"},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}}}}}},"description":"Returns the lists of blocked and allowed phone numbers"}}}}},"x-api-group":"extension/caller-blocking","x-throttling-group":"Light","x-app-permission":"EditExtensions","x-user-permission":"EditBlockedNumbers","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/caller-blocking\n\n{\n \"mode\": \"Specific\",\n \"noCallerId\": \"BlockFaxes\",\n \"payPhones\": \"Allow\",\n \"greetings\": [\n {\n \"type\": \"BlockedCallersSpecific\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398337\",\n \"id\": \"398337\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedNoCallerId\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398849\",\n \"id\": \"398849\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedPayPhones\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/399105\",\n \"id\": \"399105\",\n \"name\": \"Blocked\"\n }\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"mode\": \"Specific\",\n \"noCallerId\": \"BlockFaxes\",\n \"payPhones\": \"Allow\",\n \"greetings\": [\n {\n \"type\": \"BlockedCallersAll\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398593\",\n \"id\": \"398593\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedNoCallerId\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398849\",\n \"id\": \"398849\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedPayPhones\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/399105\",\n \"id\": \"399105\",\n \"name\": \"Blocked\"\n }\n },\n {\n \"type\": \"BlockedCallersSpecific\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/398337\",\n \"id\": \"398337\",\n \"name\": \"Blocked\"\n }\n }\n ]\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [greetings] value is invalid."}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers":{"get":{"tags":["Call Blocking"],"summary":"Get Blocked/Allowed Phone Numbers","description":"Returns the lists of blocked and allowed phone numbers.","operationId":"listBlockedAllowedNumbers","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string","enum":["Blocked","Allowed"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a list of blocked/allowed phone numbers resource"},"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}},"description":"List of blocked or allowed phone numbers"}}}}},"x-api-group":"extension/caller-blocking/phone-numbers","x-throttling-group":"Light","x-app-permission":"ReadAccounts","x-user-permission":"ReadBlockedNumbers","x-feature":"ReadBlockedNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTcxNzk2NjUwMDQ\",\n \"id\": \"MTcxNzk2NjUwMDQ\",\n \"phoneNumber\": \"+17179665004\",\n \"status\": \"Blocked\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTg4ODkwMDEwMjA\",\n \"id\": \"MTg4ODkwMDEwMjA\",\n \"phoneNumber\": \"+18889001020\",\n \"label\": \"John Doe\",\n \"status\": \"Blocked\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers?page=1&perPage=100\"\n }\n }\n} \n"}],"x-error-codes":[{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"post":{"tags":["Call Blocking"],"summary":"Add Blocked/Allowed Number","description":"Updates either blocked or allowed phone number list with a new phone number.","operationId":"createBlockedAllowedNumber","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","default":"Blocked","enum":["Blocked","Allowed"]}},"description":"Updates either blocked or allowed phone number list with a new phone number."}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"}}}}},"x-api-group":"extension/caller-blocking/phone-numbers","x-throttling-group":"Medium","x-app-permission":"EditExtensions","x-user-permission":"EditBlockedNumbers","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers\n\n{\n \"phoneNumber\": \"16503456787\",\n \"label\": \"Batman\",\n \"status\": \"Allowed\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODc\",\n \"id\": \"MTY1MDM0NTY3ODc\",\n \"phoneNumber\": \"+16503456787\",\n \"label\": \"Batman\",\n \"status\": \"Allowed\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}":{"get":{"tags":["Call Blocking"],"summary":"Get Blocked/Allowed Number","description":"Returns blocked or allowed phone number(s) by their ID(s). Batch request is supported.","operationId":"readBlockedAllowedNumber","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blockedNumberId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"}}}}},"x-api-group":"extension/caller-blocking/phone-numbers","x-throttling-group":"Light","x-app-permission":"ReadAccounts","x-user-permission":"ReadBlockedNumbers","x-feature":"ReadBlockedNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Single Record","request":"GET /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers/MTY1MDM0NTY3ODk\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODk\",\n \"id\": \"MTY1MDM0NTY3ODk\",\n \"phoneNumber\": \"+16503456789\",\n \"label\": \"Blocked numbers #1\",\n \"status\": \"Blocked\"\n}\n"},{"title":"Multiple Records","request":"GET /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers/MTY1MDM0NTY3ODc,MTY1MDM0NTY3ODk\n","response":"HTTP 207 \n\n--Boundary_1_17636828_1513006713273\nContent-Type: application/json\n\n{\n \"response\": [\n {\n \"href\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODc\",\n \"status\": 200,\n \"responseDescription\": \"OK\"\n },\n {\n \"href\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODk\",\n \"status\": 200,\n \"responseDescription\": \"OK\"\n }\n ]\n}\n--Boundary_1_17636828_1513006713273\nContent-Type: application/json\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODc\",\n \"id\": \"MTY1MDM0NTY3ODc\",\n \"phoneNumber\": \"+16503456787\",\n \"status\": \"Allowed\"\n}\n--Boundary_1_17636828_1513006713273\nContent-Type: application/json\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTY1MDM0NTY3ODk\",\n \"id\": \"MTY1MDM0NTY3ODk\",\n \"phoneNumber\": \"+16503456789\",\n \"label\": \"Blocked numbers #1\",\n \"status\": \"Blocked\"\n}\n--Boundary_1_17636828_1513006713273--\n"}],"x-error-codes":[{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"put":{"tags":["Call Blocking"],"summary":"Update Blocked/Allowed Number","description":"Updates blocked or allowed phone number(s) by their ID(s). Batch request is supported.","operationId":"updateBlockedAllowedNumber","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blockedNumberId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","default":"Blocked","enum":["Blocked","Allowed"]}},"description":"Updates either blocked or allowed phone number list with a new phone number."}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a blocked/allowed phone number"},"id":{"type":"string","description":"Internal identifier of a blocked/allowed phone number"},"phoneNumber":{"type":"string","description":"A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"label":{"type":"string","description":"Custom name of a blocked/allowed phone number"},"status":{"type":"string","description":"Status of a phone number","enum":["Blocked","Allowed"]}},"description":"Information on a blocked/allowed phone number"}}}}},"x-api-group":"extension/caller-blocking/phone-numbers","x-throttling-group":"Medium","x-app-permission":"EditExtensions","x-user-permission":"EditBlockedNumbers","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers/MTcxNzk2NjUwMDQ\n\n{\n \"status\": \"Allowed\",\n \"label\": \"Family\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403858014008/extension/403858014008/caller-blocking/phone-numbers/MTg4ODkwMDEwMjA\",\n \"id\": \"MTg4ODkwMDEwMjA\",\n \"phoneNumber\": \"+18889001020\",\n \"label\": \"Family\",\n \"status\": \"Allowed\"\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Blocking"],"summary":"Delete Blocked/Allowed Number","description":"Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported.","operationId":"deleteBlockedAllowedNumber","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"blockedNumberId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}}},"x-api-group":"extension/caller-blocking/phone-numbers","x-throttling-group":"Medium","x-app-permission":"EditExtensions","x-user-permission":"EditBlockedNumbers","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/extension/~/caller-blocking/phone-numbers/MTY1MDM0NTY3ODk\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number":{"get":{"tags":["Call Forwarding"],"summary":"Get Forwarding Number List","description":"Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip.","operationId":"listForwardingNumbers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted.","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items).","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the forwarding number list resource"},"records":{"type":"array","description":"List of forwarding phone numbers","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/forwarding-number","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserForwardingFlipNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/forwarding-number\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404611540004/extension/404611540004/forwarding-number?page=1&perPage=100\",\n \"records\": [\n {\n \"id\": \"417276280004\",\n \"phoneNumber\": \"+16502095678\",\n \"label\": \"Mobile\",\n \"type\": \"Mobile\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"1\"\n },\n {\n \"id\": \"417276281004\",\n \"phoneNumber\": \"+16502090011\",\n \"label\": \"Home\",\n \"type\": \"Home\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"2\"\n },\n {\n \"id\": \"417276282004\",\n \"phoneNumber\": \"+16502096235\",\n \"label\": \"Work\",\n \"type\": \"Work\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"3\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 3,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404611540004/extension/404611540004/forwarding-number?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404611540004/extension/404611540004/forwarding-number?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"403","errorCode":"CMN-403","message":"The feature is not available for this extension type"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadUserForwardingFlipNumbers] permission granted with extended scope"}]},"post":{"tags":["Call Forwarding"],"summary":"Create Forwarding Number","description":"Adds a new forwarding number to the forwarding number list.","operationId":"createForwardingNumber","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"flipNumber":{"type":"integer","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Forwarding/Call flip phone type. If specified, 'label' attribute value is ignored. The default value is 'Other'","enum":["PhoneLine","Home","Mobile","Work","Other"]},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"x-api-group":"extension/forwarding-number","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserForwardingFlipNumbers","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/extension/~/forwarding-number\n\n{\n \"phoneNumber\": \"+16502096935\",\n \"label\": \"Work\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/410992943004/extension/410992943004/forwarding-number/409926525004\",\n \"id\": \"409926525004\",\n \"phoneNumber\": \"+16502096935\",\n \"label\": \"Work\",\n \"type\": \"Work\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"5\"\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"AWR-180","message":"Call handling settings not available for Fax tiers"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [phoneNumber] value is invalid."},{"httpCode":"400","errorCode":"CMN-427","message":"Feature [EditExternalForwarding] is not available for the extension [403983399020]."},{"httpCode":"400","errorCode":"FPN-103","message":"Limit of available forwarding numbers (10) exceeded"},{"httpCode":"400","errorCode":"FPN-104","message":"Limit of available custom labeled forwarding numbers (7) exceeded"},{"httpCode":"400","errorCode":"FPN-105","message":"Number +18772266587 duplicates with company/extension direct number"},{"httpCode":"400","errorCode":"FPN-108","message":"International calling is currently disabled"},{"httpCode":"400","errorCode":"FPN-109","message":"Either [phoneNumber] or [device] should be specified for [PhoneLine] forwarding phone number type"},{"httpCode":"400","errorCode":"FPN-110","message":"[phoneNumber] should be specified for [Home] forwarding phone number type"},{"httpCode":"400","errorCode":"FPN-111","message":"[device] parameter is not supported for [Home] forwarding phone number type"},{"httpCode":"400","errorCode":"FPN-112","message":"[phoneNumber] and [device] cannot be specified simultaneously"},{"httpCode":"400","errorCode":"FPN-114","message":"Forwarding to unassigned device is not available"},{"httpCode":"400","errorCode":"FPN-115","message":"Forwarding to shared line group device is not available"},{"httpCode":"400","errorCode":"FPN-116","message":"[label] should be specified for [Other] forwarding phone number type"},{"httpCode":"400","errorCode":"FPN-118","message":"Device [872019020] is already included to the forwarding list"},{"httpCode":"400","errorCode":"FPN-119","message":"Forwarding phone number with type [Work] already exists"},{"httpCode":"400","errorCode":"FPN-121","message":"Forwarding to free Softphone is not available"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"},{"httpCode":"403","errorCode":"CMN-403","message":"The feature is not available for this extension type"},{"httpCode":"404","errorCode":"FPN-113","message":"Device not found for specified [device.id]"},{"httpCode":"404","errorCode":"FPN-120","message":"Device not found for specified [phoneNumber]"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}":{"get":{"tags":["Call Forwarding"],"summary":"Get Forwarding Number","description":"Returns a specific forwarding number.","operationId":"readForwardingNumber","parameters":[{"name":"forwardingNumberId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"x-api-group":"extension/forwarding-number","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserForwardingFlipNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/forwarding-number/402838625008\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402482254008/extension/402482254008/forwarding-number/402838625008\",\n \"id\": \"402838625008\",\n \"phoneNumber\": \"+79112345678\",\n \"label\": \"Mobile\",\n \"type\": \"Mobile\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"1\"\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-403","message":"The feature is not available for this extension type"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [ReadUserForwardingFlipNumbers] permission granted with extended scope"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [forwardingNumberId] is not found"}]},"put":{"tags":["Call Forwarding"],"summary":"Update Forwarding Number","description":"Updates the existing forwarding number from the forwarding number list.","operationId":"updateForwardingNumber","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"forwardingNumberId","in":"path","description":"Internal identifier of a forwarding number; returned in response in the 'id' field","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding/call flip phone number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"features":{"type":"array","description":"Type of option this phone number is used for. Multiple values are accepted","items":{"type":"string","enum":["CallFlip","CallForwarding"]}},"flipNumber":{"type":"string","description":"Number assigned to the call flip phone number, corresponds to the shortcut dial number"},"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the other extension device"}},"description":"Forwarding device information. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"x-api-group":"extension/forwarding-number","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserForwardingFlipNumbers","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/forwarding-number/2622042004\n\n{\n \"phoneNumber\": \"+16504326573\",\n \"label\": \"Custom\",\n \"flipNumber\": \"5\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/2284232004/extension/2284232004/forwarding-number/2622042004\",\n \"id\": \"2622042004\",\n \"phoneNumber\": \"+16504326573\",\n \"label\": \"Custom\",\n \"type\": \"Other\",\n \"features\": [\n \"CallFlip\",\n \"CallForwarding\"\n ],\n \"flipNumber\": \"5\"\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"BIL-101","message":"Feature [EditCallFlip] is not available for current service plan"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [flipNumber] value is invalid."},{"httpCode":"400","errorCode":"FPN-102","message":"Label of number Home duplicates with existing forwarding number label"},{"httpCode":"400","errorCode":"FPN-105","message":"Number +18663951339 duplicates with company/extension direct number"},{"httpCode":"400","errorCode":"FPN-106","message":"Flip number 1 is already in use"},{"httpCode":"400","errorCode":"FPN-108","message":"International calling is currently disabled"},{"httpCode":"400","errorCode":"FPN-122","message":"Label cannot be changed for [Home] forwarding number"},{"httpCode":"400","errorCode":"FPN-124","message":"Parameter [device.id] cannot be changed for [Home] forwarding number"},{"httpCode":"400","errorCode":"FPN-125","message":"Forwarding phone number [type] cannot be changed"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"},{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [EditUserForwardingFlipNumbers] permission."},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [forwardingNumberId] is not found"}]},"delete":{"tags":["Call Forwarding"],"summary":"Delete Forwarding Number","description":"Deletes a forwarding number from the forwarding number list by its ID.","operationId":"deleteForwardingNumber","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"forwardingNumberId","in":"path","description":"Internal identifier of a forwarding number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{}}},"x-api-group":"extension/forwarding-number","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserForwardingFlipNumbers","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/extension/~/forwarding-number/2850503004\n","response":"HTTP 204 No Content\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [EditUserForwardingFlipNumbers] permission."},{"httpCode":"403","errorCode":"FPN-107","message":"Device number cannot be deleted from the forwarding number list"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [forwardingNumberId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule":{"get":{"tags":["Call Handling Rules"],"summary":"Get Call Handling Rules","description":"Returns call handling rules of an extension.","operationId":"listAnsweringRules","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"type","in":"query","description":"Filters custom call handling rules of the extension","schema":{"type":"string","enum":["Custom"]}},{"name":"view","in":"query","schema":{"type":"string","default":"Simple","enum":["Detailed","Simple"]}},{"name":"enabledOnly","in":"query","description":"If true, then only active call handling rules are returned","schema":{"type":"boolean","default":false}},{"name":"page","in":"query","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","schema":{"type":"string","default":"100"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule list resource","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"},"records":{"type":"array","description":"List of answering rules","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule/business-hours-rule"},"id":{"type":"string","description":"Internal identifier of an asnwering rule","example":"business-hours-rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)","example":1},"totalPages":{"type":"integer","description":"The total number of pages in a dataset.","example":1},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied","example":100},"totalElements":{"type":"integer","description":"The total number of elements in a dataset.","example":1},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty","example":0},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty","example":0}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"nextPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"previousPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}},"lastPage":{"type":"object","properties":{"uri":{"type":"string","example":"https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100"}}}}}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserAnsweringRules","x-feature":"ReadExtensionAnsweringRules","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Call Handling Rules List","request":"GET /restapi/v1.0/account/~/extension/~/answering-rule\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule/business-hours-rule\",\n \"id\": \"business-hours-rule\",\n \"type\": \"BusinessHours\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule/24494102004\",\n \"id\": \"24494102004\",\n \"type\": \"Custom\",\n \"name\": \"My Rule # 1\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule/after-hours-rule\",\n \"id\": \"after-hours-rule\",\n \"type\": \"AfterHours\",\n \"enabled\": true\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 3,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12843281004/extension/12843281004/answering-rule?page=1&perPage=100\"\n }\n }\n}\n"},{"title":"Custom Call Handling Rules","request":"GET /account/~/extension/~/answering-rule?type=Custom\n\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/62534323/extension/62534323/answering-rule?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/62534323/extension/62534323/answering-rule/422580011\",\n \"id\": \"422580011\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #1\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/62534323/extension/62534323/answering-rule/422580012\",\n \"id\": \"422580012\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #2\",\n \"enabled\": true\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": { \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/62534323/extension/62534323/answering-rule?page=1&perPage=100\"\n },\n },\n}\n\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]},"post":{"tags":["Call Handling Rules"],"summary":"Create Call Handling Rule","description":"Creates a custom call handling rule for a particular caller ID.","operationId":"createAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'"},"type":{"type":"string","description":"Type of an answering rule. The 'Custom' value should be specified"},"name":{"type":"string","description":"Name of an answering rule specified by user"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"callers":{"type":"array","description":"Answering rules are applied when calls are received from specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/extension/~/answering-rule\n\n{\n \"callers\": [\n {\n \"callerId\": \"+46843216868\"\n },\n {\n \"callerId\": \"+46843216860\"\n }\n ],\n \"type\": \"Custom\",\n \"name\": \"My Rule 2\",\n \"screening\": \"Always\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/400430664008/extension/400430664008/answering-rule/400592844008\",\n \"id\": \"400592844008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule 2\",\n \"enabled\": true,\n \"callers\": [\n {\n \"callerId\": \"46843216860\"\n },\n {\n \"callerId\": \"46843216868\"\n }\n ],\n \"callHandlingAction\": \"ForwardCalls\",\n \"forwarding\": {\n \"notifyMySoftPhones\": true,\n \"notifyAdminSoftPhones\": false,\n \"softPhonesRingCount\": 1,\n \"ringingMode\": \"Sequentially\"\n },\n \"voicemail\": {\n \"enabled\": true,\n \"recipient\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/400430664008/extension/400430664008\",\n \"id\": 400430664008\n }\n },\n \"screening\": \"Always\",\n \"greetings\": [\n {\n \"type\": \"Voicemail\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/65792\",\n \"id\": \"65792\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Introductory\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66301\",\n \"id\": \"66301\",\n \"name\": \"None\"\n }\n },\n {\n \"type\": \"ConnectingAudio\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66310\",\n \"id\": \"66310\",\n \"name\": \"Acoustic\"\n }\n },\n {\n \"type\": \"ConnectingMessage\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/68867\",\n \"id\": \"68867\",\n \"name\": \"Default\"\n }\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}":{"get":{"tags":["Call Handling Rules"],"summary":"Get Call Handling Rule","description":"Returns an call handling rule by ID.","operationId":"readAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either 'business-hours-rule' or 'after-hours-rule'","required":true,"schema":{"type":"string"}},{"name":"showInactiveNumbers","in":"query","description":"Indicates whether inactive numbers should be returned or not","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"callers":{"type":"array","description":"Answering rules are applied when calls are received from specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserAnsweringRules","x-feature":"ReadExtensionAnsweringRules","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Business Hours Rule","request":"GET /restapi/v1.0/account/~/extension/~/answering-rule/business-hours-rule\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/2601711004/extension/2601711004/answering-rule/business-hours-rule\",\n \"id\": \"business-hours-rule\",\n \"type\": \"BusinessHours\",\n \"enabled\": true,\n \"schedule\": {\n \"ref\": \"BusinessHours\"\n },\n \"callHandlingAction\": \"ForwardCalls\",\n \"forwarding\": {\n \"notifyMySoftPhones\": true,\n \"notifyAdminSoftPhones\": false,\n \"softPhonesRingCount\": 1,\n \"ringingMode\": \"Sequentially\",\n \"rules\": []\n },\n \"voicemail\": {\n \"enabled\": true,\n \"recipient\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/2601711004/extension/2601711004\",\n \"id\": 2601711004\n }\n },\n \"greetings\": [\n {\n \"type\": \"Voicemail\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/65792\",\n \"id\": \"65792\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Introductory\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66301\",\n \"id\": \"66301\",\n \"name\": \"None\"\n }\n },\n {\n \"type\": \"ConnectingAudio\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66310\",\n \"id\": \"66310\",\n \"name\": \"Acoustic\"\n }\n },\n {\n \"type\": \"ConnectingMessage\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/68867\",\n \"id\": \"68867\",\n \"name\": \"Default\"\n }\n }\n ]\n}\n"},{"title":"Custom Rule","request":"GET /restapi/v1.0/account/~/extension/~/answering-rule/404626175008\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/answering-rule/404626175008\",\n \"id\": \"404626175008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule 1\",\n \"enabled\": true,\n \"calledNumbers\": [\n {\n \"phoneNumber\": \"+13233120138\"\n }\n ],\n \"greetings\": [\n {\n \"type\": \"Voicemail\",\n \"custom\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/greeting/400011074008\",\n \"id\": \"400011074008\"\n }\n },\n {\n \"type\": \"Introductory\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66301\",\n \"id\": \"66301\",\n \"name\": \"None\"\n }\n },\n {\n \"type\": \"ConnectingAudio\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66310\",\n \"id\": \"66310\",\n \"name\": \"Acoustic\"\n }\n },\n {\n \"type\": \"Announcement\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66560\",\n \"id\": \"66560\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Unavailable\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66816\",\n \"id\": \"66816\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"ConnectingMessage\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/68867\",\n \"id\": \"68867\",\n \"name\": \"Default\"\n }\n }\n ],\n \"callHandlingAction\": \"ForwardCalls\",\n \"forwarding\": {\n \"notifyMySoftPhones\": true,\n \"notifyAdminSoftPhones\": false,\n \"softPhonesRingCount\": 1,\n \"ringingMode\": \"Sequentially\",\n \"rules\": [\n {\n \"index\": 1,\n \"ringCount\": 1,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/forwarding-number/402927279008\",\n \"id\": \"402927279008\",\n \"phoneNumber\": \"+16500000001\",\n \"label\": \"Work\"\n }\n ]\n },\n {\n \"index\": 2,\n \"ringCount\": 2,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/forwarding-number/402927280008\",\n \"id\": \"402927280008\",\n \"phoneNumber\": \"+16500000002\",\n \"label\": \"Mobile\"\n }\n ]\n },\n {\n \"index\": 3,\n \"ringCount\": 3,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/forwarding-number/402927281008\",\n \"id\": \"402927281008\",\n \"phoneNumber\": \"+16500000003\",\n \"label\": \"Home\"\n }\n ]\n },\n {\n \"index\": 4,\n \"ringCount\": 4,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008/forwarding-number/402927282008\",\n \"id\": \"402927282008\",\n \"phoneNumber\": \"+16500000004\",\n \"label\": \"Other\"\n }\n ]\n }\n ]\n },\n \"voicemail\": {\n \"enabled\": true,\n \"recipient\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402539300008/extension/402539300008\",\n \"id\": 402539300008\n }\n },\n \"screening\": \"Off\"\n}\n"}],"x-error-codes":null},"put":{"tags":["Call Handling Rules"],"summary":"Update Call Handling Rule","description":"Updates a custom call handling rule for a particular caller ID.","operationId":"updateAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of an answering rule"},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True'"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True'"},"softPhonesRingCount":{"type":"integer","description":"Specifies delay between ring on apps and starting of a call forwarding"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially'","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal. Not returned for inactive numbers"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group). For inactive numbers the default value ('4') is returned"},"enabled":{"type":"boolean","description":"Phone number status"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"type":{"type":"string","description":"Forwarding phone number type","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'"},"name":{"type":"string","description":"Name of an answering rule specified by user"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"showInactiveNumbers":{"type":"boolean","description":"Indicates whether inactive numbers should be returned or not"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI to an answering rule resource"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of an answering rule","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user"},"enabled":{"type":"boolean","description":"Specifies if an answering rule is active or inactive"},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time intervals for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule"},"ranges":{"type":"array","description":"Specific data ranges","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"callers":{"type":"array","description":"Answering rules are applied when calls are received from specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Contact name of a caller"}}}},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded","enum":["ForwardCalls","UnconditionalForwarding","AgentQueue","TransferToExtension","TakeMessagesOnly","PlayAnnouncementOnly","SharedLines"]},"forwarding":{"type":"object","properties":{"notifyMySoftPhones":{"type":"boolean","description":"Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers"},"notifyAdminSoftPhones":{"type":"boolean","description":"Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False'"},"softPhonesRingCount":{"type":"integer","description":"Number of rings before forwarding starts"},"ringingMode":{"type":"string","description":"Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time","enum":["Sequentially","Simultaneously"]},"rules":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"index":{"type":"integer","description":"Forwarding number (or group) ordinal"},"ringCount":{"type":"integer","description":"Number of rings for a forwarding number (or group)"},"enabled":{"type":"boolean","description":"Forwarding number status. Returned only if `showInactiveNumbers` is set to `true`"},"forwardingNumbers":{"type":"array","description":"Forwarding number (or group) data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a forwarding number"},"uri":{"type":"string","description":"Canonical URI of a forwarding/call flip phone number"},"phoneNumber":{"type":"string","description":"Forwarding/Call flip phone number"},"label":{"type":"string","description":"Forwarding/Call flip number title"},"type":{"type":"string","description":"Type of a forwarding number","enum":["Home","Mobile","Work","PhoneLine","Outage","Other","BusinessMobilePhone","ExternalCarrier"]}}}}}}},"mobileTimeout":{"type":"boolean","description":"Specifies if mobile timeout is activated for the rule"}},"description":"Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded"},"unconditionalForwarding":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"},"queue":{"type":"object","properties":{"transferMode":{"type":"string","description":"Specifies how calls are transferred to group members","enum":["Rotating","Simultaneous","FixedOrder"]},"transfer":{"type":"array","description":"Call transfer information","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension the call is transferred to"},"name":{"type":"string","description":"Extension name"},"extensionNumber":{"type":"string","description":"Extension number"}}},"action":{"type":"string","description":"Event that initiates transferring to the specified extension","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}}}},"noAnswerAction":{"type":"string","description":"Specifies the type of action to be taken if: members are available but no one answers, or all members are busy/unavailable. This option is available for Business hours only. For simultaneous transfer mode only 'WaitPrimaryMembers' and 'WaitPrimaryAndOverflowMembers' are supported","enum":["WaitPrimaryMembers","WaitPrimaryAndOverflowMembers","Voicemail","TransferToExtension","UnconditionalForwarding"]},"fixedOrderAgents":{"type":"array","description":"Information on a call forwarding rule","items":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Name of agent extension"}}},"index":{"type":"integer","description":"Ordinal of an agent (call queue member)"}}}},"holdAudioInterruptionMode":{"type":"string","description":"Connecting audio interruption mode","enum":["Never","WhenMusicEnds","Periodically"]},"holdAudioInterruptionPeriod":{"type":"integer","description":"Connecting audio interruption message period in seconds"},"holdTimeExpirationAction":{"type":"string","description":"Specifies the type of action to be taken after the hold time (waiting for an available call queue member) expires. If 'TransferToExtension' option is selected, the extension specified in `transfer` field is used. The default value is `Voicemail`","default":"Voicemail","enum":["TransferToExtension","UnconditionalForwarding","Voicemail"]},"agentTimeout":{"type":"integer","description":"Maximum time in seconds to wait for a call queue member before trying the next member"},"wrapUpTime":{"type":"integer","description":"Minimum post-call wrap up time in seconds before agent status is automatically set; the value range is from 180 to 300"},"holdTime":{"type":"integer","description":"Maximum hold time in seconds to wait for an available call queue member"},"maxCallers":{"type":"integer","description":"Maximum count of callers on hold; the limitation is 25 callers"},"maxCallersAction":{"type":"string","description":"Specifies the type of action to be taken if count of callers on hold exceeds the supported maximum","enum":["Voicemail","Announcement","TransferToExtension","UnconditionalForwarding"]},"unconditionalForwarding":{"type":"array","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number to which the call is forwarded. In addition to common e.164 format, the following number patterns are supported: 11xxxxxxxxxxx, 444xxxxxxxxxxx, 616xxxxxxxxxxx; where xxxxxxxxxxx is a phone number in e.164 format (without '+' sign)"},"action":{"type":"string","description":"Event that initiates forwarding to the specified phone number","enum":["HoldTimeExpiration","MaxCallers","NoAnswer"]}},"description":"Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction'"}}},"description":"Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action"},"transfer":{"type":"object","properties":{"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"description":"Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action"},"voicemail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If 'True' then voicemails are allowed to be received"},"recipient":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a recipient extension resource"},"id":{"type":"integer","description":"Internal identifier of a recipient extension"}},"description":"Recipient data"}},"description":"Specifies whether to take a voicemail and who should do it"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}},"screening":{"type":"string","description":"Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off'","enum":["Off","NoCallerId","UnknownCallerId","Always"]},"sharedLines":{"type":"object","properties":{"timeout":{"type":"integer","description":"Number of seconds to wait before forwarding unanswered calls. The value range is 10 - 80"}},"description":"SharedLines call handling action settings"}}}}}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/answering-rule/1351451004\n\n{\n \"name\": \"My Rule #1\",\n \"enabled\": \"true\",\n \"forwarding\": {\n \"notifyMySoftPhones\": true,\n \"softPhonesRingCount\": 5,\n \"ringingMode\": \"Sequentially\",\n \"rules\": [\n {\n \"index\": 1,\n \"ringCount\": 3,\n \"forwardingNumbers\": [\n {\n \"id\": \"989084004\"\n }\n ]\n },\n {\n \"index\": 2,\n \"forwardingNumbers\": [\n {\n \"id\": \"989085004\"\n }\n ]\n }\n ]\n },\n \"voicemail\": {\n \"enabled\": true,\n \"recipient\": {\n \"id\": 889545004\n }\n },\n \"screening\": \"Always\",\n \"greetings\": [\n {\n \"type\": \"Voicemail\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/65792\",\n \"id\": \"65792\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Introductory\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66301\",\n \"id\": \"66301\",\n \"name\": \"None\"\n }\n },\n {\n \"type\": \"ConnectingAudio\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66310\",\n \"id\": \"66310\",\n \"name\": \"Acoustic\"\n }\n },\n {\n \"type\": \"ConnectingMessage\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/68867\",\n \"id\": \"68867\",\n \"name\": \"Default\"\n }\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/889543004/extension/889543004/answering-rule/1351451004\",\n \"id\": \"1351451004\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #1\",\n \"enabled\": true,\n \"callers\": [\n {\n \"callerId\": \"46843216868\"\n },\n {\n \"callerId\": \"46843216860\"\n }\n ],\n \"greetings\": [\n {\n \"type\": \"Voicemail\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/65792\",\n \"id\": \"65792\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Introductory\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66301\",\n \"id\": \"66301\",\n \"name\": \"None\"\n }\n },\n {\n \"type\": \"ConnectingAudio\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66310\",\n \"id\": \"66310\",\n \"name\": \"Acoustic\"\n }\n },\n {\n \"type\": \"Announcement\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66560\",\n \"id\": \"66560\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"Unavailable\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66816\",\n \"id\": \"66816\",\n \"name\": \"Default\"\n }\n },\n {\n \"type\": \"ConnectingMessage\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/68867\",\n \"id\": \"68867\",\n \"name\": \"Default\"\n }\n }\n ],\n \"callHandlingAction\": \"ForwardCalls\",\n \"forwarding\": {\n \"notifyMySoftPhones\": true,\n \"notifyAdminSoftPhones\": false,\n \"softPhonesRingCount\": 5,\n \"ringingMode\": \"Sequentially\",\n \"rules\": [\n {\n \"index\": 1,\n \"ringCount\": 3,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/889543004/extension/889543004/forwarding-number/989084004\",\n \"id\": \"989084004\",\n \"phoneNumber\": \"+16500000001\",\n \"label\": \"Work\"\n }\n ]\n },\n {\n \"index\": 2,\n \"ringCount\": 4,\n \"forwardingNumbers\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/889543004/extension/889543004/forwarding-number/989085004\",\n \"id\": \"989085004\",\n \"phoneNumber\": \"+16500000002\",\n \"label\": \"Mobile\"\n }\n ]\n }\n ]\n },\n \"voicemail\": {\n \"enabled\": true,\n \"recipient\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/889543004/extension/889545004\",\n \"id\": 889545004\n }\n },\n \"screening\": \"Always\"\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"delete":{"tags":["Call Handling Rules"],"summary":"Delete Call Handling Rule","description":"Deletes a custom call handling rule by a particular ID.","operationId":"deleteAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/extension/~/answering-rule/401000267008\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/answering-rule":{"get":{"tags":["Call Handling Rules"],"summary":"Get Company Call Handling Rule List","description":"Returns a list of company call handling rules.","operationId":"listCompanyAnsweringRules","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items per page)","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an answering rule resource"},"records":{"type":"array","description":"List of company answering rules","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"type":{"type":"string","description":"Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"calledNumbers":{"type":"array","description":"Answering rules are applied when calling to selected number(s)","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Called phone number"}}}},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"}}}}}}},"x-api-group":"account/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyAnsweringRules","x-feature":"ReadAccountAnsweringRules","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/answering-rule\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule/408841690008\",\n \"id\": \"408841690008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #1\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule/408841692008\",\n \"id\": \"408841692008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #2\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule/408841691008\",\n \"id\": \"408841691008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #3\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule/408841689008\",\n \"id\": \"408841689008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #4\",\n \"enabled\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule/business-hours-rule\",\n \"id\": \"business-hours-rule\",\n \"type\": \"BusinessHours\",\n \"enabled\": true\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 5,\n \"pageStart\": 0,\n \"pageEnd\": 4\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404721120008/answering-rule?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Call Handling Rules"],"summary":"Create Company Call Handling Rule","description":"Creates call handling rule on account level.","operationId":"createCompanyAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"type":{"type":"string","description":"Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom']","enum":["BusinessHours","AfterHours","Custom"]},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"string","description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive","default":true},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}}}}}},"x-api-group":"account/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyAnsweringRules","x-feature":"EditAccountAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/answering-rule\n\n{\n \"callers\": [\n {\n \"callerId\": \"1\"\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/111222333/answering-rule/12345678\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #1\",\n \"callers\": [\n {\n \"callerId\": \"1\"\n }\n ],\n \"callHandlingAction\": \"Operator\",\n \"greetings\": [\n {\n \"type\": \"Company\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/54321\",\n \"id\": \"54321\",\n \"name\": \"Default\"\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/answering-rule/{ruleId}":{"get":{"tags":["Call Handling Rules"],"summary":"Get Company Call Handling Rule","description":"Returns a company call handling rule by ID.","operationId":"readCompanyAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either 'business-hours-rule' or 'after-hours-rule'","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive","default":true},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}}}}}},"x-api-group":"account/answering-rule","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyAnsweringRules","x-feature":"ReadAccountAnsweringRules","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Custom","request":"GET /restapi/v1.0/account/~/answering-rule/12345678\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/111222333/answering-rule/12345678\",\n \"type\": \"Custom\",\n \"name\": \"My Rule #1\",\n \"callers\": [\n {\n \"callerId\": \"1\"\n }\n ],\n \"callHandlingAction\": \"Operator\",\n \"greetings\": [\n {\n \"type\": \"Company\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/54321\",\n \"id\": \"54321\",\n \"name\": \"Default\"\n }\n }\n ]\n}\n"},{"title":"Business Hours","request":"GET /restapi/v1.0/account/~/answering-rule/business-hours-rule\n","response":"HTTP 200 OK\n\n{\n \"id\": \"business-hours-rule\",\n \"type\": \"BusinessHours\",\n \"enabled\": true,\n \"callHandlingAction\": \"AgentQueue\",\n \"queue\": {\n \"transferMode\": \"Rotating\",\n \"fixedOrderAgents\": [\n {\n \"extension\": {\n \"id\": \"411753183004\",\n \"extensionNumber\": \"8526\",\n \"name\": \"John Smith\"\n },\n \"index\": 1\n }\n ],\n \"holdAudioInterruptionMode\": \"WhenMusicEnds\",\n \"holdAudioInterruptionPeriod\": 200,\n \"holdTimeExpirationAction\": \"UnconditionalForwarding\",\n \"agentTimeout\": 60,\n \"wrapUpTime\": 60,\n \"holdTime\": 60,\n \"maxCallers\": 20,\n \"maxCallersAction\": \"TransferToExtension\", \n \"noAnswerAction\": \"TransferToExtension\",\n \"unconditionalForwarding\": \n {\n \"phoneNumber\": \"+19623589565\",\n \"action\": \"HoldTimeExpiration\"\n ]\n }\n ],\n \"transfer\": [ \n {\n \"extension\": {\n \"id\": \"10006546\",\n \"extensionNumber\": \"522\",\n \"name\": \"Agent 1\"\n },\n \"action\": \"MaxCallers\"\n ]\n },\n {\n \"extension\": {\n \"id\": \"10006547\",\n \"extensionNumber\": \"564\",\n \"name\": \"Agent 2\"\n },\n \"action\": \"NoAnswer\"\n }\n ]\n }\n}\n"}],"x-error-codes":null},"put":{"tags":["Call Handling Rules"],"summary":"Update Company Call Handling Rule","description":"Updates a company call handling rule.","operationId":"updateCompanyAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either 'business-hours-rule' or 'after-hours-rule'","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive. The default value is 'True'","default":true},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect','Bypass']","enum":["Operator","Disconnect","Bypass"]},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"extension":{"type":"string","description":"Internal identifier of the extension the call is forwarded to. Supported for 'Bypass' mode only (that should be specified in `callHandlingAction` field)"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an answering rule"},"uri":{"type":"string","description":"Canonical URI of an answering rule"},"enabled":{"type":"boolean","description":"Specifies if the rule is active or inactive","default":true},"type":{"type":"string","description":"Type of an answering rule","default":"Custom","enum":["BusinessHours","AfterHours","Custom"]},"name":{"type":"string","description":"Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number"},"callers":{"type":"array","description":"Answering rule will be applied when calls are received from the specified caller(s)","items":{"type":"object","properties":{"callerId":{"type":"string","description":"Phone number of a caller"},"name":{"type":"string","description":"Displayed name for a caller ID"}}}},"calledNumbers":{"type":"array","description":"Answering rule will be applied when calling the specified number(s)","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account phone number"},"phoneNumber":{"type":"string","description":"Phone number of a callee"}}}},"schedule":{"type":"object","properties":{"weeklyRanges":{"type":"object","properties":{"monday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"tuesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"wednesday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"thursday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"friday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"saturday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}},"sunday":{"type":"array","description":"Time interval for a particular day","items":{"type":"object","properties":{"from":{"type":"string","description":"Time in format hh:mm"},"to":{"type":"string","description":"Time in format hh:mm"}}}}},"description":"Weekly schedule. If specified, ranges cannot be specified"},"ranges":{"type":"array","description":"Specific data ranges. If specified, weeklyRanges cannot be specified","items":{"type":"object","properties":{"from":{"type":"string","description":"Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"},"to":{"type":"string","description":"Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100*"}}}},"ref":{"type":"string","description":"Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours']","enum":["BusinessHours","AfterHours"]}},"description":"Schedule when an answering rule should be applied"},"callHandlingAction":{"type":"string","description":"Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass']","enum":["Operator","Disconnect","Bypass"]},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Extension to which the call is forwarded in 'Bypass' mode"},"greetings":{"type":"array","description":"Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Custom","Company","BlockedCallersSpecific","BlockedCallersAll","BlockedNoCallerId","BlockedPayPhones","StartRecording","StopRecording","AutomaticRecording"]},"preset":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a greeting resource"},"id":{"type":"string","description":"Internal identifier of a greeting"},"name":{"type":"string","description":"Name of a greeting"}}},"custom":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom user greeting"}}}}}}}}}}}},"x-api-group":"account/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyAnsweringRules","x-feature":"EditAccountAnsweringRules","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/answering-rule/406321858008\n\n{\n \"callers\": [\n {\n \"callerId\": \"1\"\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403426382008/answering-rule/406321858008\",\n \"id\": \"406321858008\",\n \"type\": \"Custom\",\n \"name\": \"My Rule 1\",\n \"enabled\": true,\n \"callers\": [\n {\n \"callerId\": \"1\"\n }\n ],\n \"greetings\": [\n {\n \"type\": \"Company\",\n \"preset\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/262145\",\n \"id\": \"262145\",\n \"name\": \"Company Greeting\"\n }\n }\n ],\n \"callHandlingAction\": \"Operator\"\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Handling Rules"],"summary":"Delete Company Call Handling Rule","description":"Deletes a company custom call handling rule by a particular ID.","operationId":"deleteCompanyAnsweringRule","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"ruleId","in":"path","description":"Internal identifier of an answering rule","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/answering-rule","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyAnsweringRules","x-feature":"EditAccountAnsweringRules","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/answering-rule/406321858008\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/dictionary/greeting":{"get":{"tags":["Greetings"],"summary":"Get Standard Greeting List","description":"Returns the list of predefined standard greetings. Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings.","operationId":"listStandardGreetings","parameters":[{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted.","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items).","schema":{"type":"integer","default":100}},{"name":"type","in":"query","description":"Type of a greeting, specifying the case when the greeting is played","schema":{"type":"string","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","HoldMusic","Company"]}},{"name":"usageType","in":"query","description":"Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension","schema":{"type":"string","enum":["UserExtensionAnsweringRule","ExtensionAnsweringRule","DepartmentExtensionAnsweringRule","CompanyAnsweringRule","CompanyAfterHoursAnsweringRule","VoicemailExtensionAnsweringRule","AnnouncementExtensionAnsweringRule","SharedLinesGroupAnsweringRule"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of greetings list resource"},"records":{"type":"array","description":"List of greetings","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting"},"uri":{"type":"string","description":"Link to a greeting"},"name":{"type":"string","description":"Name of a greeting"},"usageType":{"type":"string","description":"Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension.","enum":["UserExtensionAnsweringRule","ExtensionAnsweringRule","DepartmentExtensionAnsweringRule","BlockedCalls","CallRecording","CompanyAnsweringRule","CompanyAfterHoursAnsweringRule","LimitedExtensionAnsweringRule","VoicemailExtensionAnsweringRule","AnnouncementExtensionAnsweringRule","SharedLinesGroupAnsweringRule"]},"text":{"type":"string","description":"Text of a greeting, if any"},"contentUri":{"type":"string","description":"Link to a greeting content (audio file), if any"},"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","AutomaticRecording","BlockedCallersAll","BlockedCallersSpecific","BlockedNoCallerId","BlockedPayPhones","ConnectingMessage","ConnectingAudio","StartRecording","StopRecording","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Company"]},"category":{"type":"string","description":"Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None']","enum":["Music","Message","RingTones","None"]},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/greeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/greeting?type=ConnectingAudio&perPage=4&page=4\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting?type=ConnectingAudio&page=4&perPage=4\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66319\",\n \"id\": \"66319\",\n \"name\": \"Reggae\",\n \"usageType\": \"UserExtensionAnsweringRule\",\n \"contentUri\": \"https://media.ringcentral.com/greetings/en_US/1210/reggae.wav\",\n \"type\": \"ConnectingAudio\",\n \"category\": \"Music\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66304\",\n \"id\": \"66304\",\n \"name\": \"None\",\n \"usageType\": \"UserExtensionAnsweringRule\",\n \"type\": \"ConnectingAudio\",\n \"category\": \"None\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66307\",\n \"id\": \"66307\",\n \"name\": \"Ring Tones\",\n \"usageType\": \"UserExtensionAnsweringRule\",\n \"type\": \"ConnectingAudio\",\n \"category\": \"RingTones\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/131847\",\n \"id\": \"131847\",\n \"name\": \"Beautiful\",\n \"usageType\": \"DepartmentExtensionAnsweringRule\",\n \"contentUri\": \"https://media.ringcentral.com/greetings/en_US/1210/beautiful.wav\",\n \"type\": \"ConnectingAudio\",\n \"category\": \"Music\"\n }\n ],\n \"paging\": {\n \"page\": 4,\n \"totalPages\": 8,\n \"perPage\": 4,\n \"totalElements\": 30,\n \"pageStart\": 12,\n \"pageEnd\": 15\n },\n \"navigation\": {\n \"nextPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting?type=ConnectingAudio&page=5&perPage=4\"\n },\n \"previousPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting?type=ConnectingAudio&page=3&perPage=4\"\n },\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting?type=ConnectingAudio&page=1&perPage=4\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting?type=ConnectingAudio&page=8&perPage=4\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [page] value is invalid."}]}},"/restapi/v1.0/dictionary/greeting/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get Standard Greeting","description":"Returns a standard greeting by ID.","operationId":"readStandardGreeting","parameters":[{"name":"greetingId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting"},"uri":{"type":"string","description":"Link to a greeting"},"name":{"type":"string","description":"Name of a greeting"},"usageType":{"type":"string","description":"Usage type of a greeting, specifying if the greeting is applied for user extension or department (call queue) extension.","enum":["UserExtensionAnsweringRule","ExtensionAnsweringRule","DepartmentExtensionAnsweringRule","BlockedCalls","CallRecording","CompanyAnsweringRule","CompanyAfterHoursAnsweringRule","LimitedExtensionAnsweringRule","VoicemailExtensionAnsweringRule","AnnouncementExtensionAnsweringRule","SharedLinesGroupAnsweringRule"]},"text":{"type":"string","description":"Text of a greeting, if any"},"contentUri":{"type":"string","description":"Link to a greeting content (audio file), if any"},"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","AutomaticRecording","BlockedCallersAll","BlockedCallersSpecific","BlockedNoCallerId","BlockedPayPhones","ConnectingMessage","ConnectingAudio","StartRecording","StopRecording","Voicemail","Unavailable","InterruptPrompt","HoldMusic","Company"]},"category":{"type":"string","description":"Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None']","enum":["Music","Message","RingTones","None"]},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/greeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/greeting/66319\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/66319\",\n \"id\": \"66319\",\n \"name\": \"Reggae\",\n \"usageType\": \"UserExtensionAnsweringRule\",\n \"contentUri\": \"https://media.ringcentral.com/greetings/en_US/1210/reggae.wav\",\n \"type\": \"ConnectingAudio\",\n \"category\": \"Music\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/greeting":{"post":{"tags":["Greetings"],"summary":"Create Company Greeting","description":"Creates a custom company greeting.","operationId":"createCompanyGreeting","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"multipart/mixed":{"schema":{"required":["binary","type"],"properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Company","StartRecording","StopRecording","AutomaticRecording"]},"answeringRuleId":{"type":"string","description":"Internal identifier of an answering rule"},"languageId":{"type":"string","description":"Internal identifier of a language. See Get Language List"},"binary":{"type":"string","description":"Meida file to upload","format":"binary"}}}},"multipart/form-data":{"schema":{"required":["binary","type"],"properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Company","StartRecording","StopRecording","AutomaticRecording"]},"answeringRuleId":{"type":"string","description":"Internal identifier of an answering rule"},"languageId":{"type":"string","description":"Internal identifier of a language. See Get Language List"},"binary":{"type":"string","description":"Meida file to upload","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension custom greeting"},"id":{"type":"string","description":"Internal identifier of an answering rule"},"type":{"type":"string","description":"Type of a company greeting","enum":["Company","StartRecording","StopRecording","AutomaticRecording"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"uri":{"type":"string","description":"Link to a greeting language"},"name":{"type":"string","description":"Name of a greeting language"},"localeCode":{"type":"string","description":"Locale code of a greeting language"}},"description":"Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording'"}}}}}}},"x-api-group":"extension/greeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"ReadUserInfo","x-feature":"ReadExtensionInfo","x-docs-level":"Public","x-http-examples":[{"title":"Multipart/Mixed","request":"POST /restapi/v1.0/account/2011423004/greeting\nContent-Type: multipart/mixed; boundary=Boundary_14_2952358_1361963763144\n \n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"json\"\nContent-Type: application/json; charset=UTF-8\nContent-Transfer-Encoding: 8bit\n{ \n \"type\": \"Company\",\n \"answeringRule\": { \"id\": \"12345678\" }\n}\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"binary\"; filename=\"mygreeting.wav\"\nContent-Type: audio/wav\nContent-Transfer-Encoding: binary\n[binary data]\n--Boundary_14_2952358_1361963763144--\n","response":"HTTP 200 OK\n\n{\n \"id\": \"3104221004\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/2011423004/greeting/3104221004\",\n \"type\": \"Company\",\n \"contentType\": \"audio/wav\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/2011457004/greeting/3104221004/content\",\n \"answeringRule\": {\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/2011423004/answering-rule/12345678\"\n }\n \n}\n"},{"title":"Multipart/Form-data","request":"POST /restapi/v1.0/account/400513103008/greeting\nContent-Type: multipart/form-data; boundary=19dj0d239d23d\n\n--19dj0d239d23d\nContent-Disposition: form-data; name=\"type\"\nContent-Type: text/plain\nContent-Transfer-Encoding: 8bit\n\nCompany\n--19dj0d239d23d\nContent-Disposition: form-data; name=\"answeringRuleId\"\nContent-Type: text/plain\nContent-Transfer-Encoding: 8bit\n\n400776730008\n--19dj0d239d23d\nContent-Disposition: form-data; name=\"binary\"; filename=\"mygreeting.wav\"\nContent-Type: audio/wav\nContent-Transfer-Encoding: binary\n\n[binary data]\n--19dj0d239d23d-\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400513103008/greeting/400007455008\",\n \"id\" : \"400007455008\",\n \"type\" : \"Company\",\n \"contentType\" : \"audio/wav\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/400513103008/greeting/400007455008/content\",\n \"answeringRule\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400513103008/answering-rule/400776730008\",\n \"id\" : \"400776730008\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"AWR-129","message":"Invalid attachment media type"},{"httpCode":"400","errorCode":"AWR-178","message":"Greeting type [Voicemail] is not applicable to company rule"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [type] value is invalid."},{"httpCode":"400","errorCode":"CMN-102","message":"Resource for parameter [answeringRule.id] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting":{"post":{"tags":["Greetings"],"summary":"Create Custom User Greeting","description":"Creates custom greeting for an extension user.","operationId":"createCustomUserGreeting","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"apply","in":"query","description":"Specifies whether to apply an answering rule or not. If set to true then `answeringRule` parameter is mandatory. If set to false, then the answering rule is not applied even if specified","schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"multipart/mixed":{"schema":{"required":["binary","type"],"properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","HoldMusic"]},"answeringRuleId":{"type":"string","description":"Internal identifier of an answering rule"},"binary":{"type":"string","description":"Meida file to upload","format":"binary"}}}},"multipart/form-data":{"schema":{"required":["binary","type"],"properties":{"type":{"type":"string","description":"Type of a greeting, specifying the case when the greeting is played.","enum":["Introductory","Announcement","ConnectingMessage","ConnectingAudio","Voicemail","Unavailable","HoldMusic"]},"answeringRuleId":{"type":"string","description":"Internal identifier of an answering rule"},"binary":{"type":"string","description":"Meida file to upload","format":"binary"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom user greeting"},"id":{"type":"string","description":"Internal identifier of a custom user greeting"},"type":{"type":"string","description":"Type of a custom user greeting","enum":["Introductory","Announcement","InterruptPrompt","ConnectingAudio","ConnectingMessage","Voicemail","Unavailable","HoldMusic","PronouncedName"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"}}}}}}},"x-api-group":"extension/greeting","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserAnsweringRules","x-feature":"EditExtensionAnsweringRules","x-docs-level":"Public","x-http-examples":[{"title":"Multipart/Mixed","request":"POST /restapi/v1.0/account/37439510/extension/61307231006/greeting\nContent-Type: multipart/mixed;boundary=Boundary_14_2952358_1361963763144\n\n{ \n \"type\": \"Voicemail\",\n \"answeringRule\": { \"id\": \"3107589020\" }\n}\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"binary\"; filename=\"mygreeting.wav\"\nContent-Type: audio/wav\nContent-Transfer-Encoding: binary\n\n[binary data]\n--Boundary_14_2952358_1361963763144--\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751564020\",\n \"id\" : \"751564020\",\n \"type\" : \"Voicemail\",\n \"contentType\" : \"audio/wav\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751564020/content\",\n \"answeringRule\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/answering-rule/3107589020\",\n \"id\" : \"3107589020\"\n }\n}\n\n"},{"title":"Multipart/Mixed w/o Answering Rule","request":"POST /restapi/v1.0/account/37439510/extension/61307231006/greeting?apply=false\nContent-Type: multipart/mixed;boundary=Boundary_14_2952358_1361963763144\n\n{ \n \"type\": \"Voicemail\"\n}\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"binary\"; filename=\"mygreeting.wav\"\nContent-Type: audio/wav\nContent-Transfer-Encoding: binary\n\n[binary data]\n--Boundary_14_2952358_1361963763144--\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751564020\",\n \"id\" : \"751564020\",\n \"type\" : \"Voicemail\",\n \"contentType\" : \"audio/wav\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751564020/content\"\n}\n\n"},{"title":"Multipart/Form-data","request":"POST /restapi/v1.0/account/37439510/extension/61307231006/greeting\nContent-Type: multipart/form-data;boundary=Boundary_14_2952358_1361963763144\n\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"json\"\nContent-Type: application/json; charset=UTF-8\nContent-Transfer-Encoding: 8bit\n\n{ \n \"type\": \"Voicemail\",\n \"answeringRule\": { \"id\": \"3107589020\" }\n}\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"binary\"; filename=\"mygreeting.wav\"\nContent-Type: audio/wav\nContent-Transfer-Encoding: binary\n\n[binary data]\n--Boundary_14_2952358_1361963763144--\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751566020\",\n \"id\" : \"751566020\",\n \"type\" : \"Voicemail\",\n \"contentType\" : \"audio/wav\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/greeting/751566020/content\",\n \"answeringRule\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/extension/61307231006/answering-rule/3107589020\",\n \"id\" : \"3107589020\"\n }\n}\n\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"AWR-128","message":"Attachment body is empty"},{"httpCode":"400","errorCode":"AWR-129","message":"Invalid attachment media type"},{"httpCode":"400","errorCode":"AWR-165","message":"Hold music can be set for business hours rule only: the same value will be applied to all rules"},{"httpCode":"400","errorCode":"AWR-166","message":"Greeting type [Voicemail] is not applicable to [SharedLinesGroup] extension type"},{"httpCode":"400","errorCode":"CLR-103","message":"Company level greeting cannot be created on user level."},{"httpCode":"400","errorCode":"CMN-100","message":"Mandatory parameter [answeringRule] not specified"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [type] value is invalid."},{"httpCode":"400","errorCode":"CMN-102","message":"Resource for parameter [answeringRule.id] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get Custom Greeting","description":"Returns a custom user greeting by ID.","operationId":"readCustomGreeting","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"greetingId","in":"path","description":"Internal identifier of a greeting","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom user greeting"},"id":{"type":"string","description":"Internal identifier of a custom user greeting"},"type":{"type":"string","description":"Type of a custom user greeting","enum":["Introductory","Announcement","InterruptPrompt","ConnectingAudio","ConnectingMessage","Voicemail","Unavailable","HoldMusic","PronouncedName"]},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]},"contentUri":{"type":"string","description":"Link to a greeting content (audio file)"},"answeringRule":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of an answering rule"},"id":{"type":"string","description":"Internal identifier of an answering rule"}},"description":"Information on an answering rule that the greeting is applied to"}}}}}}},"x-api-group":"extension/greeting","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserInfo","x-feature":"ReadExtensionInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/greeting/400026725008\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/408382226008/extension/408382226008/greeting/400026725008\",\n \"id\" : \"400026725008\",\n \"type\" : \"Voicemail\",\n \"contentType\" : \"audio/wav\",\n \"contentUri\" : \"https://media.ringcentral.com/restapi/v1.0/account/408382226008/extension/408382226008/greeting/400026725008/content\",\n \"answeringRule\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/408382226008/extension/408382226008/answering-rule/415656975008\",\n \"id\" : \"415656975008\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [greetingId] is not found"}]}},"/restapi/v1.0/account/{accountId}/ivr-prompts":{"get":{"tags":["IVR"],"summary":"Get IVR Prompt List","description":"Returns the list of IVR prompts.","operationId":"listIVRPrompts","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to prompts library resource"},"records":{"type":"array","description":"List of Prompts","items":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyGreetings","x-feature":"ReadAccountGreetings","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/ivr-prompts\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts?page=1&perPage=100\",\n \"records\": [\n {\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678/content\",\n \"contentType\": \"audio/mp3\",\n \"filename\": \"myprompt.mp3\"\n },\n {\n \"id\": \"56781234\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/56781234\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/56781234/content\",\n \"contentType\": \"audio/mp3\",\n \"filename\": \"myspecialprompt.mp3\"\n },\n {\n \"id\": \"43218765\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/43218765\",\n \"contentUri\": \"media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/43218765/content\",\n \"contentType\": \"audio/mp3\",\n \"filename\": \"salesprompt.mp3\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 3,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["IVR"],"summary":"Create IVR Prompts","description":"Creates an IVR prompt.","operationId":"createIVRPrompt","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["attachment"],"properties":{"attachment":{"type":"string","description":"Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported","format":"binary"},"name":{"type":"string","description":"Description of file contents."}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}}}}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyGreetings","x-feature":"EditAccountGreetings","x-docs-level":"Public","x-http-examples":[{"title":"Multipart/mixed","request":"POST /restapi/v1.0/account/~/ivr-prompts\nContent-Type: multipart/mixed; boundary=Boundary_1_14413901_1361871080888\n\n--Boundary_1_14413901_1361871080888\nContent-Type: application/json\n\n{\n \"name\": \"My Prompt\"\n}\n--Boundary_1_14413901_1361871080888\nContent-Type: audio/mp3\nContent-Transfer-Encoding: binary\nContent-Disposition: attachment; filename=\"myprompt.mp3\"\n\n// binary data\n--Boundary_1_14413901_1361871080888--\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678/content\",\n \"filename\": \"myprompt.mp3\"\n}\n"},{"title":"Multipart/form-data","request":"POST /restapi/v1.0/account/~/ivr-prompts\nContent-Type: multipart/form-data; boundary=Boundary_14_2952358_1361963763144\n\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"name\"\nContent-Transfer-Encoding: 8bit\nContent-Type: text/plain\n\nMy Prompt\n--Boundary_14_2952358_1361963763144\nContent-Disposition: form-data; name=\"attachment\"; filename=\"myprompt.mp3\"\nContent-Transfer-Encoding: binary\nContent-Type: audio/mp3\n\n// binary data\n--Boundary_14_2952358_1361963763144--\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678/content\",\n \"filename\": \"myprompt.mp3\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}":{"get":{"tags":["IVR"],"summary":"Get IVR Prompt","description":"Returns an IVR prompt by ID.","operationId":"readIVRPrompt","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"promptId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Prompt Information","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}}}}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyGreetings","x-feature":"ReadAccountGreetings","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/ivr-prompts/12345678\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678\",\n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678/content\",\n \"contentType\": \"audio/mp3\",\n \"filename\": \"sample.mp3\"\n}\n"}],"x-error-codes":null},"put":{"tags":["IVR"],"summary":"Update IVR Prompt","description":"Updates an IVR prompt by ID","operationId":"updateIVRPrompt","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"promptId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"filename":{"type":"string","description":"Name of a file to be uploaded as a prompt"}}}}},"required":false},"responses":{"200":{"description":"Updated Prompt Information","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Internal identifier of a prompt"},"id":{"type":"string","description":"Link to a prompt metadata"},"contentType":{"type":"string","description":"Type of a prompt media content"},"contentUri":{"type":"string","description":"Link to a prompt media content"},"filename":{"type":"string","description":"Name of a prompt"}}}}}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyGreetings","x-feature":"EditAccountGreetings","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/ivr-prompts/12345678 \n\n{ \n \"filename\": \"my-renamed-prompt.mp3\" \n} \n","response":"HTTP 200 OK \n\n{ \n \"id\": \"12345678\", \n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678\", \n \"contentUri\": \"https://media.ringcentral.com/restapi/v1.0/account/87654321/ivr-prompts/12345678/content\",\n \"contentType\": \"audio/mp3\", \n \"filename\": \"my-renamed-prompt.mp3\" \n} \n"}],"x-error-codes":null},"delete":{"tags":["IVR"],"summary":"Delete IVR Prompt","description":"Deletes an IVR prompt by ID.","operationId":"deleteIVRPrompt","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"promptId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyGreetings","x-feature":"EditAccountGreetings","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/ivr-prompts/12345678\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content":{"get":{"tags":["IVR"],"summary":"Get IVR Prompt Content","description":"Returns media content of an IVR prompt by ID.","operationId":"readIVRPromptContent","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"promptId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"IVR Prompt Media Data","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"account/ivr-prompts","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyGreetings","x-feature":"ReadAccountGreetings","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/ivr-prompts/12345678/content\n","response":"HTTP 200 OK\n\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/ivr-menus":{"post":{"tags":["IVR"],"summary":"Create IVR Menu","description":"Creates a company IVR menu.","operationId":"createIVRMenu","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}}}}}},"x-api-group":"account/ivr-menus","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"AutoReceptionist","x-feature":"EditAutoReceptionist","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/403933036008/ivr-menus\n\n{\n \"extensionNumber\": \"124\",\n \"name\": \"IVR 124\",\n \"site\": {\n \"id\": \"12345678\",\n \"name\": \"Main Office\"\n },\n \"actions\": [\n {\n \"input\": \"2\",\n \"action\": \"Voicemail\",\n \"extension\": {\n \"id\": \"403933036008\"\n }\n },\n {\n \"input\": \"4\",\n \"action\": \"Transfer\",\n \"phoneNumber\": \"+16502223344\"\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403933036008/ivr-menus/403933041008\",\n \"id\": \"403933041008\",\n \"name\": \"IVR 124\",\n \"site\": {\n \"id\": \"12345678\",\n \"name\": \"Main Office\"\n },\n \"extensionNumber\": \"124\",\n \"actions\": [\n {\n \"input\": \"2\",\n \"action\": \"Voicemail\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403933036008/extension/403933036008\",\n \"id\": \"403933036008\"\n }\n },\n {\n \"input\": \"4\",\n \"action\": \"Transfer\",\n \"phoneNumber\": \"+16502223344\"\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}":{"get":{"tags":["IVR"],"summary":"Get IVR Menu","description":"Returns a company IVR menu by ID.","operationId":"readIVRMenu","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ivrMenuId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}}}}}},"x-api-group":"account/ivr-menus","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"AutoReceptionist","x-feature":"EditAutoReceptionist","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/ivr-menus/12345678\n","response":"HTTP 200 OK\n\n{\n \"id\": \"12345678\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12341234/ivr-menus/12345678\",\n \"extensionNumber\": \"10\",\n \"site\": {\n \"id\": \"main-site\",\n \"name\": \"Main Site\"\n },\n \"name\": \"IVR 10\",\n \"prompt\": {\n \"mode\": \"Audio\",\n \"audio\": {\n \"id\": \"8765421\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12341234/ivr-prompts/87654321\"\n }\n },\n \"actions\": [\n {\n \"input\": \"1\",\n \"action\": \"Connect\",\n \"extension\": {\n \"id\": \"111222333\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12341234/extension/111222333\"\n }\n },\n {\n \"input\": \"2\",\n \"action\": \"Voicemail\",\n \"extension\": {\n \"id\": \"444555666\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12341234/extension/444555666\"\n }\n },\n {\n \"input\": \"3\",\n \"action\": \"DialByName\"\n },\n {\n \"input\": \"4\",\n \"action\": \"Transfer\",\n \"phoneNumber\": \"+16502223344\"\n },\n {\n \"input\": \"Hash\",\n \"action\": \"Repeat\"\n },\n {\n \"input\": \"Star\",\n \"action\": \"ReturnToRoot\"\n },\n {\n \"input\": \"NoInput\",\n \"action\": \"Connect\",\n \"extension\": {\n \"id\": \"777888999\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12341234/extension/777888999\"\n }\n }\n ]\n}\n"}],"x-error-codes":null},"put":{"tags":["IVR"],"summary":"Update IVR Menu","description":"Updates a company IVR menu by ID.","operationId":"updateIVRMenu","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ivrMenuId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an IVR Menu extension"},"uri":{"type":"string","description":"Link to an IVR Menu extension resource"},"name":{"type":"string","description":"First name of an IVR Menu user"},"extensionNumber":{"type":"string","description":"Number of an IVR Menu extension"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. If the value is not specified in request, then the `main-site` default value is used"},"name":{"type":"string","description":"Site name"}},"description":"Site data"},"prompt":{"type":"object","properties":{"mode":{"type":"string","description":"Prompt mode: custom media or text","enum":["Audio","TextToSpeech"]},"audio":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt audio file"},"id":{"type":"string","description":"Internal identifier of a prompt"}},"description":"For 'Audio' mode only. Prompt media reference"},"text":{"type":"string","description":"For 'TextToSpeech' mode only. Prompt text"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a prompt language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"For 'TextToSpeech' mode only. Prompt language metadata"}},"description":"Prompt metadata"},"actions":{"type":"array","description":"Keys handling settings","items":{"type":"object","properties":{"input":{"type":"string","description":"Key. The following values are supported: numeric: '1' to '9' Star Hash NoInput "},"action":{"type":"string","description":"Internal identifier of an answering rule","enum":["Connect","Voicemail","DialByName","Transfer","Repeat","ReturnToRoot","ReturnToPrevious","Disconnect"]},"extension":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an extension resource"},"id":{"type":"string","description":"Internal identifier of an extension"},"name":{"type":"string","description":"Name of an extension"}},"description":"For 'Connect' or 'Voicemail' actions only. Extension reference"},"phoneNumber":{"type":"string","description":"For 'Transfer' action only. PSTN number in E.164 format"}}}}}}}}}},"x-api-group":"account/ivr-menus","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"AutoReceptionist","x-feature":"EditAutoReceptionist","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/ivr-menus/403813622008\n\n{\n \"name\": \"IVR 157\",\n \"extensionNumber\": \"157\",\n \"site\": {\n \"id\": \"12345678\",\n \"name\": \"Main Office\"\n },\n \"actions\": [\n {\n \"input\": \"1\",\n \"action\": \"Connect\",\n \"extension\": {\n \"id\": \"403813622008\"\n }\n },\n {\n \"input\": \"2\",\n \"action\": \"Voicemail\",\n \"extension\": {\n \"id\": \"403813622008\"\n }\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403813619008/ivr-menus/403813622008\",\n \"id\": \"403813622008\",\n \"name\": \"IVR 157\",\n \"extensionNumber\": \"157\",\n \"site\": {\n \"id\": \"12345678\",\n \"name\": \"Main Office\"\n },\n \"actions\": [\n {\n \"input\": \"1\",\n \"action\": \"Connect\",\n \"extension\": {\n \"uri\": \"http://api.ringcentral.com/restapi/v1.0/account/403813619008/extension/403813622008\",\n \"id\": \"403813622008\"\n }\n },\n {\n \"input\": \"2\",\n \"action\": \"Voicemail\",\n \"extension\": {\n \"uri\": \"http://api.ringcentral.com/restapi/v1.0/account/403813619008/extension/403813622008\",\n \"id\": \"403813622008\"\n }\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-recording":{"get":{"tags":["Call Recording Settings"],"summary":"Get Call Recording Settings","description":"Returns call recording settings.","operationId":"readCallRecordingSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"onDemand":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controlling OnDemand Call Recording settings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"}}},"automatic":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controling Automatic Call Recording settings"},"outboundCallTones":{"type":"boolean","description":"Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings"},"outboundCallAnnouncement":{"type":"boolean","description":"Flag for controlling 'Play periodic tones for outbound calls' settings"},"allowMute":{"type":"boolean","description":"Flag for controlling 'Allow mute in auto call recording' settings"},"extensionCount":{"type":"integer","description":"Total amount of extension that are used in call recordings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"},"maxNumberLimit":{"type":"integer","description":"Max number of automatic call recordings per account, the default value is 100 000"}}},"greetings":{"type":"array","description":"Collection of Greeting Info","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"mode":{"type":"string","description":"'Default' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then 'Custom' value is returned.","enum":["Default","Custom"]}}}}}}}}}},"x-api-group":"account/call-recording","x-throttling-group":"Light","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/call-recording\n","response":"HTTP 200 OK\n\n{\n \"onDemand\": {\n \"enabled\": true,\n \"retentionPeriod\": 90\n },\n \"automatic\": {\n \"enabled\": false,\n \"outboundCallTones\": true,\n \"outboundCallAnnouncement\": false,\n \"allowMute\": false,\n \"extensionCount\": 2,\n \"retentionPeriod\": 90,\n \"maxNumberLimit\": 100000\n },\n \"greetings\": [\n {\n \"type\": \"StartRecording\",\n \"mode\": \"Default\"\n },\n {\n \"type\": \"StopRecording\",\n \"mode\": \"Default\"\n },\n {\n \"type\": \"AutomaticRecording\",\n \"mode\": \"Default\"\n }\n ]\n}\n"}],"x-error-codes":null},"put":{"tags":["Call Recording Settings"],"summary":"Update Call Recording Settings","description":"Updates current call recording settings.","operationId":"updateCallRecordingSettings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"onDemand":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controlling OnDemand Call Recording settings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"}}},"automatic":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controling Automatic Call Recording settings"},"outboundCallTones":{"type":"boolean","description":"Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings"},"outboundCallAnnouncement":{"type":"boolean","description":"Flag for controlling 'Play periodic tones for outbound calls' settings"},"allowMute":{"type":"boolean","description":"Flag for controlling 'Allow mute in auto call recording' settings"},"extensionCount":{"type":"integer","description":"Total amount of extension that are used in call recordings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"},"maxNumberLimit":{"type":"integer","description":"Max number of automatic call recordings per account, the default value is 100 000"}}},"greetings":{"type":"array","description":"Collection of Greeting Info","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"mode":{"type":"string","description":"'Default' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then 'Custom' value is returned.","enum":["Default","Custom"]}}}}}}}},"required":false},"responses":{"200":{"description":"OK: Updated Call Recording Settings","content":{"application/json":{"schema":{"type":"object","properties":{"onDemand":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controlling OnDemand Call Recording settings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"}}},"automatic":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag for controling Automatic Call Recording settings"},"outboundCallTones":{"type":"boolean","description":"Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings"},"outboundCallAnnouncement":{"type":"boolean","description":"Flag for controlling 'Play periodic tones for outbound calls' settings"},"allowMute":{"type":"boolean","description":"Flag for controlling 'Allow mute in auto call recording' settings"},"extensionCount":{"type":"integer","description":"Total amount of extension that are used in call recordings"},"retentionPeriod":{"type":"integer","description":"Retention period of a call recording, the default value is 90 days"},"maxNumberLimit":{"type":"integer","description":"Max number of automatic call recordings per account, the default value is 100 000"}}},"greetings":{"type":"array","description":"Collection of Greeting Info","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"mode":{"type":"string","description":"'Default' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then 'Custom' value is returned.","enum":["Default","Custom"]}}}}}}}}}},"x-api-group":"account/call-recording","x-throttling-group":"Medium","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyInfo","x-feature":"EditCompanyInfo","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/call-recording\n\n{\n \"onDemand\": {\n \"enabled\": true\n },\n \"automatic\": {\n \"enabled\": true,\n \"outboundCallTones\": true,\n \"outboundCallAnnouncement\": true,\n \"allowMute\": true\n },\n \"greetings\": [\n {\n \"type\": \"StartRecording\"\n },\n {\n \"type\": \"StopRecording\"\n },\n {\n \"type\": \"AutomaticRecording\"\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"onDemand\": {\n \"enabled\": true\n },\n \"automatic\": {\n \"enabled\": true,\n \"outboundCallTones\": true,\n \"outboundCallAnnouncement\": true,\n \"allowMute\": true,\n \"extensionCount\": 2\n },\n \"greetings\": [\n {\n \"type\": \"StartRecording\",\n \"mode\": \"Default\"\n },\n {\n \"type\": \"StopRecording\",\n \"mode\": \"Default\"\n },\n {\n \"type\": \"AutomaticRecording\",\n \"mode\": \"Default\"\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-recording/extensions":{"get":{"tags":["Call Recording Settings"],"summary":"Get Call Recording Extension List","description":"Returns the list of extensions to be recorded.","operationId":"listCallRecordingExtensions","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Extension List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to call recording extension list resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Name of an extension"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-recording/extensions","x-throttling-group":"Medium","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/call-recording/extensions\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401597525008/call-recording/extensions?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401597525008/extension/401597525008\",\n \"id\": \"401597525008\",\n \"extensionNumber\": \"101\",\n \"type\": \"User\",\n \"callDirection\": \"Outbound\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401597525008/extension/401597527008\",\n \"id\": \"401597527008\",\n \"extensionNumber\": \"102\",\n \"type\": \"User\",\n \"callDirection\": \"All\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401597525008/call-recording/extensions?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401597525008/call-recording/extensions?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-recording/bulk-assign":{"post":{"tags":["Call Recording Settings"],"summary":"Update Call Recording Extension List","description":"Creates or updates the list of extensions to be recorded.","operationId":"updateCallRecordingExtensionList","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}},"updatedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}},"removedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string"},"extensionNumber":{"type":"string"},"type":{"type":"string"},"callDirection":{"type":"string","description":"Direction of call","enum":["Outbound","Inbound","All"]}}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{}}},"x-api-group":"account/call-recording/bulk-assign","x-throttling-group":"Medium","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/1468821004/call-recording/bulk-assign\n\n{\n \"addedExtensions\": [\n {\n \"id\": \"1468821004\",\n \"callDirection\": \"All\"\n }\n ],\n \"updatedExtensions\": [\n {\n \"id\": \"1468823004\",\n \"callDirection\": \"Outbound\"\n }\n ]\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-recording/custom-greetings":{"get":{"tags":["Call Recording Settings"],"summary":"Get Call Recording Custom Greeting List","description":"Returns call recording custom greetings.","operationId":"listCallRecordingCustomGreetings","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["StartRecording","StopRecording","AutomaticRecording"]},"custom":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a custom company greeting"},"id":{"type":"string","description":"Internal identifier of a custom company greeting"}},"description":"Custom greeting data"},"language":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a language"},"id":{"type":"string","description":"Internal identifier of a language"},"name":{"type":"string","description":"Language name"},"localeCode":{"type":"string","description":"Language locale code"}},"description":"Custom greeting language"}}}}},"description":"Returns data on call recording custom greetings."}}}}},"x-beta-api":true,"x-api-group":"account/call-recording/custom-greetings","x-throttling-group":"Medium","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-metered-api":true,"x-docs-level":"Public","x-metering-group":"System","x-availability":"High","x-http-examples":[{"request":"GET https://platform.ringcentral.com/restapi/v1.0/account/~/call-recording/custom-greetings?type=StartRecording\n","response":"HTTP 200 OK\n\n{\n \"records\": [\n {\n \"type\": \"StartRecording\",\n \"custom\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401171566008/greeting/8765\",\n \"id\": \"8765\"\n },\n \"language\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1031\",\n \"id\": \"1031\",\n \"name\": \"German (Germany)\",\n \"localeCode\": \"de-DE\"\n }\n }\n ]\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Recording Settings"],"summary":"Delete Call Recording Custom Greeting List","description":"Deletes call recording custom greetings.","operationId":"deleteCallRecordingCustomGreetingList","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/call-recording/custom-greetings","x-throttling-group":"Medium","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyInfo","x-feature":"EditCompanyInfo","x-metered-api":true,"x-docs-level":"Public","x-metering-group":"System","x-http-examples":[{"request":"DELETE https://platform.ringcentral.com/restapi/v1.0/account/~/call-recording/custom-greetings?type=StartRecording\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-recording/custom-greetings/{greetingId}":{"delete":{"tags":["Call Recording Settings"],"summary":"Delete Call Recording Custom Greeting","description":"Deletes call recording custom greeting(s).","operationId":"deleteCallRecordingCustomGreeting","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"greetingId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{}}},"x-api-group":"account/call-recording/custom-greetings","x-throttling-group":"Medium","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyInfo","x-feature":"EditCompanyInfo","x-metered-api":true,"x-docs-level":"Public","x-metering-group":"System","x-http-examples":[{"request":"DELETE https://platform.ringcentral.com/restapi/v1.0/account/~/call-recording/custom-greetings/213584\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/client-info/sip-provision":{"post":{"tags":["Device SIP Registration"],"summary":"Register Device","description":"Creates SIP registration of a device/application (WebPhone, Mobile, softphone).","operationId":"createSIPRegistration","requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Device unique identifier, retrieved at previous session (if any)"},"appExternalId":{"type":"string","description":"Supported for iOS devices only. Certificate name (used by iOS applications for APNS subscription)"},"computerName":{"type":"string","description":"Supported for SoftPhone only. Computer name"},"serial":{"type":"string","description":"Serial number for HardPhone; `endpoint_id` for softphone and mobile applications. Returned only when the phone is shipped and provisioned"}},"description":"Device information"},"sipInfo":{"type":"array","description":"SIP settings for device","items":{"type":"object","properties":{"transport":{"type":"string","description":"Supported transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]}}}}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["sipFlags","sipInfo"],"type":"object","properties":{"device":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a device resource"},"id":{"type":"string","description":"Internal identifier of a Device"},"type":{"type":"string","description":"Device type","enum":["HardPhone","SoftPhone","OtherPhone","Paging","WebPhone"]},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"status":{"type":"string","enum":["Online","Offline"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"required":["addons"],"type":"object","properties":{"id":{"type":"string","description":"Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"string","format":"int32"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Link to an extension resource"},"extensionNumber":{"type":"string","description":"Number of extension"}},"description":"Internal identifier of an extension the device should be assigned to"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]},"addressRequired":{"type":"boolean","description":"'True' if emergency address is required for the country of a phone line"},"addressLocationOnly":{"type":"boolean","description":"'True' if out of country emergency address is not allowed for the country of a phone line"}},"description":"Emergency response location settings of a device"},"shipping":{"type":"object","properties":{"address":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"method":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"type":"string"},"carrier":{"type":"string"},"trackingNumber":{"type":"string"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local']","enum":["External","TollFree","Local"]},"phoneNumber":{"maxLength":128,"minLength":0,"type":"string","description":"Phone number"},"usageType":{"type":"string","enum":["CompanyNumber","MainCompanyNumber","AdditionalCompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]},"type":{"type":"string","description":"Type of a phone number","enum":["VoiceFax","FaxOnly","VoiceOnly"]}},"description":"Phone number information"}}}},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}},"sipInfo":{"type":"array","description":"SIP settings for device","items":{"type":"object","properties":{"username":{"type":"string","description":"User credentials"},"password":{"type":"string","description":"User password"},"authorizationId":{"type":"string","description":"Identifier for SIP authorization"},"domain":{"type":"string","description":"SIP domain"},"outboundProxy":{"type":"string","description":"SIP outbound proxy"},"outboundProxyIPv6":{"type":"string","description":"SIP outbound IPv6 proxy"},"outboundProxyBackup":{"type":"string","description":"SIP outbound proxy backup"},"outboundProxyIPv6Backup":{"type":"string","description":"SIP outbound IPv6 proxy backup"},"transport":{"type":"string","description":"Preferred transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]},"certificate":{"type":"string","description":"For TLS transport only Base64 encoded certificate"},"switchBackInterval":{"type":"integer","description":"The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call."}}}},"sipInfoPstn":{"type":"array","description":"SIP PSTN settings for device","items":{"type":"object","properties":{"username":{"type":"string","description":"User credentials"},"password":{"type":"string","description":"User password"},"authorizationId":{"type":"string","description":"Identifier for SIP authorization"},"domain":{"type":"string","description":"SIP domain"},"outboundProxy":{"type":"string","description":"SIP outbound proxy"},"outboundProxyIPv6":{"type":"string","description":"SIP outbound IPv6 proxy"},"outboundProxyBackup":{"type":"string","description":"SIP outbound proxy backup"},"outboundProxyIPv6Backup":{"type":"string","description":"SIP outbound IPv6 proxy backup"},"transport":{"type":"string","description":"Preferred transport. SIP info will be returned for this transport if supported","enum":["UDP","TCP","TLS","WS","WSS"]},"certificate":{"type":"string","description":"For TLS transport only Base64 encoded certificate"},"switchBackInterval":{"type":"integer","description":"The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call."}}}},"sipFlags":{"type":"object","properties":{"voipFeatureEnabled":{"type":"string","description":"If 'True' VoIP calling feature is enabled","enum":["True","False"]},"voipCountryBlocked":{"type":"string","description":"If 'True' the request is sent from IP address of a country blocked for VoIP calling","enum":["True","False"]},"outboundCallsEnabled":{"type":"string","description":"If 'True' outbound calls are enabled","enum":["True","False"]},"dscpEnabled":{"type":"boolean"},"dscpSignaling":{"type":"integer"},"dscpVoice":{"type":"integer"},"dscpVideo":{"type":"integer"}},"description":"SIP flags data"},"sipErrorCodes":{"type":"array","items":{"type":"string"}}}}}}}},"x-api-group":"client-info/sip-provision","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"VoipCalling","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"WebRTC","request":"POST /restapi/v1.0/client-info/sip-provision\n\n{\n \"sipInfo\": [\n {\n \"transport\": \"WSS\"\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"device\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/809646016/device/802398804016\",\n \"id\": \"802398804016\",\n \"type\": \"WebPhone\",\n \"status\": \"Online\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/809646016/extension/62264425016\",\n \"id\": 62264425016,\n \"extensionNumber\": \"115\"\n },\n \"phoneLines\": [\n {\n \"lineType\": \"Standalone\",\n \"emergencyAddress\": {\n \"required\": true,\n \"localOnly\": false\n },\n \"phoneInfo\": {\n \"id\": 121116105016,\n \"phoneNumber\": \"+16504223279\",\n \"paymentType\": \"Local\",\n \"type\": \"VoiceFax\",\n \"usageType\": \"DirectNumber\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\"\n }\n }\n }\n ],\n \"emergencyServiceAddress\": {\n \"street\": \"20 DAVIS DR\",\n \"street2\": \"\",\n \"city\": \"BELMONT\",\n \"state\": \"CA\",\n \"stateId\": \"16\",\n \"stateIsoCode\": \"CA\",\n \"stateName\": \"California\",\n \"country\": \"US\",\n \"countryId\": \"1\",\n \"countryIsoCode\": \"US\",\n \"countryName\": \"United States\",\n \"zip\": \"94002\",\n \"customerName\": \"John Smith\",\n \"outOfCountry\": false\n },\n \"linePooling\": \"Guest\"\n },\n \"sipInfo\": [\n {\n \"transport\": \"WSS\",\n \"username\": \"17203861294*115\",\n \"password\": \"0XeL9qcf\",\n \"authorizationId\": \"802398804016\",\n \"domain\": \"sip.ringcentral.com\",\n \"outboundProxy\": \"sip112-191.ringcentral.com:8083\",\n \"outboundProxyBackup\": \"sip132-171.ringcentral.com:8083\"\n }\n ],\n \"sipInfoPstn\": [],\n \"sipFlags\": {\n \"voipFeatureEnabled\": true,\n \"voipCountryBlocked\": false,\n \"outboundCallsEnabled\": true,\n \"dscpEnabled\": false,\n \"dscpSignaling\": 26,\n \"dscpVoice\": 46,\n \"dscpVideo\": 34\n },\n \"sipErrorCodes\": [\n \"408\"\n ]\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-124","message":"Method is extension specific"},{"httpCode":"400","errorCode":"OAU-232","message":"Extension not found"},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"403","errorCode":"SPR-101","message":"null"},{"httpCode":"403","errorCode":"SPR-112","message":"Client edition is not compatible with current Brand"},{"httpCode":"403","errorCode":"SPR-132","message":"null"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"},{"httpCode":"499","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"503","errorCode":"CMN-201","message":"Service Temporary Unavailable"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number":{"get":{"tags":["Phone Numbers"],"summary":"Get Extension Phone Number List","description":"Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension.","operationId":"listExtensionPhoneNumbers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"status","in":"query","description":"Status of a phone number. Multiple values are supported","schema":{"type":"string","enum":["Normal","Pending","PortedIn","Temporary"]}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"usageType","in":"query","description":"Usage type of a phone number","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","BusinessMobileNumber","ExternalMobileNumber"]}}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'","schema":{"type":"integer"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). If not specified, the value is '100' by default","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK: User Phone Number List","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the user's phone number list resource"},"records":{"type":"array","description":"List of phone numbers","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the user's phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Site"]},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"features":{"type":"array","description":"List of features of a phone number","items":{"type":"string","enum":["CallerId","SmsSender","A2PSmsSender","MmsSender","InternationalSmsSender","Delegated"]}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/phone-number","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserPhoneNumbers","x-feature":"ReadExtensionPhoneNumbers","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/1715084004/extension/1715084004/phone-number\n","response":"HTTP 200 OK\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1715084004/extension/1715084004/phone-number?page=1&perPage=100\",\n \"records\" : [ {\n \"id\" : 1162144004,\n \"phoneNumber\" : \"+18442023350\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"FaxOnly\",\n \"usageType\" : \"CompanyFaxNumber\",\n \"status\" : \"Normal\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n },\n \"features\" : [ \"CallerId\" ]\n }, {\n \"id\" : 1162142004,\n \"phoneNumber\" : \"+18662023452\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"MainCompanyNumber\",\n \"status\" : \"Normal\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n },\n \"features\" : [ \"CallerId\" ]\n }, {\n \"id\" : 1162143004,\n \"phoneNumber\" : \"+18662023453\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceOnly\",\n \"usageType\" : \"CompanyNumber\",\n \"status\" : \"Normal\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n },\n \"features\" : [ \"CallerId\" ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 3,\n \"pageStart\" : 0,\n \"pageEnd\" : 2\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1715084004/extension/1715084004/phone-number?page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1715084004/extension/1715084004/phone-number?page=1&perPage=100\"\n }\n }\n }\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}":{"get":{"tags":["User Settings"],"summary":"Get Extension","description":"Returns basic information about a particular extension.","operationId":"readExtension","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Extension information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"account":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"}},"description":"Account information"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"departments":{"type":"array","description":"Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","items":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"id":{"type":"string","description":"Internal identifier of a department extension"},"uri":{"type":"string","description":"Canonical URI of a department extension"},"extensionNumber":{"type":"string","description":"Number of a department extension"}}}},"extensionNumber":{"type":"string","description":"Number of extension"},"extensionNumbers":{"type":"array","items":{"type":"string"}},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"serviceFeatures":{"type":"array","description":"Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features","items":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}}},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup).","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}}}}}},"x-api-group":"extension","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-service-level":500,"x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Update","Delete"]},"hints":{"type":"array","description":"Returned for 'Update' event type only","items":{"type":"string","enum":["AccountSettings","AccountStatus","AnsweringRules","CompanyNumbers","DialingPlan","ExtensionInfo","Features","Limits","Permissions","ProfileImage","VideoConfiguration"]}},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-http-examples":[{"title":"Assigned Extension","request":"GET /restapi/v1.0/account/~/extension/~\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004\",\n \"id\": 871817004,\n \"extensionNumber\": \"101\",\n \"contact\": {\n \"firstName\": \"Alice\",\n \"lastName\": \"Smith\",\n \"company\": \"Example, Inc.\",\n \"email\": \"alice.smith@example.com\",\n \"businessPhone\": \"+12484897302\",\n \"businessAddress\": {\n \"street\": \"13 Elm Street\",\n \"city\": \"Foster City\",\n \"zip\": \"94404\",\n \"state\": \"CA\",\n \"country\": \"United States\"\n },\n \"emailAsLoginName\": true,\n \"pronouncedName\": {\n \"type\": \"Default\",\n \"text\": \"Alice Smith\"\n }\n },\n \"name\": \"Alice Smith\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"serviceFeatures\": [\n {\n \"featureName\": \"SMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SMSReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Pager\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PagerReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Voicemail\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Fax\",\n \"enabled\": true\n },\n {\n \"featureName\": \"FaxReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"DND\",\n \"enabled\": true\n },\n {\n \"featureName\": \"RingOut\",\n \"enabled\": true\n },\n {\n \"featureName\": \"InternationalCalling\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Presence\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VideoConferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SalesForce\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Intercom\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Paging\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Conferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VoipCalling\",\n \"enabled\": true\n },\n {\n \"featureName\": \"FreeSoftPhoneLines\",\n \"enabled\": false,\n \"reason\": \"ExtensionLimitation\"\n },\n {\n \"featureName\": \"HipaaCompliance\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"CallPark\",\n \"enabled\": true\n },\n {\n \"featureName\": \"OnDemandCallRecording\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Reports\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallForwarding\",\n \"enabled\": true\n },\n {\n \"featureName\": \"DeveloperPortal\",\n \"enabled\": true\n },\n {\n \"featureName\": \"EncryptionAtRest\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"BlockedMessageForwarding\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"EmergencyCalling\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"HDVoice\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SingleExtensionUI\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"CallSupervision\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"VoicemailToText\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"WebPhone\",\n \"enabled\": true\n },\n {\n \"featureName\": \"RCTeams\",\n \"enabled\": true\n },\n {\n \"featureName\": \"UserManagement\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Calendar\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PasswordAuth\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallerIdControl\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticInboundCallRecording\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticOutboundCallRecording\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticCallRecordingMute\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"SoftPhoneUpdate\",\n \"enabled\": true\n },\n {\n \"featureName\": \"LinkedSoftphoneLines\",\n \"enabled\": false,\n \"reason\": \"AccountTypeLimitation\"\n },\n {\n \"featureName\": \"CallQualitySurvey\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AccountFederation\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"MMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallParkLocations\",\n \"enabled\": true\n },\n {\n \"featureName\": \"ExternalDirectoryIntegration\",\n \"enabled\": false,\n \"reason\": \"AccountTypeLimitation\"\n },\n {\n \"featureName\": \"CallSwitch\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PromoMessage\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SiteCodes\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"InternationalSMS\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n }\n ],\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/14\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n },\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"12h\"\n },\n \"setupWizardState\": \"Completed\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": true\n },\n \"internationalCalling\": {\n \"enabled\": true\n }\n },\n \"profileImage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image\",\n \"etag\": \"7a1decb8efda89d7c0acff42f061d99d\",\n \"contentType\": \"image/gif\",\n \"lastModified\": \"2018-01-29T09:29:45.316Z\",\n \"scales\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/90x90\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/195x195\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/584x584\"\n }\n ]\n },\n \"account\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004\",\n \"id\": \"871817004\"\n },\n \"site\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/site/871836004\",\n \"id\": \"871836004\",\n \"name\": \"Store 7\"\n },\n \"hidden\": false\n}\n"},{"title":"Unassigned Extension","request":"GET /restapi/v1.0/account/~/extension/3236457004\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/3236457004\",\n \"id\" : 3236457004,\n \"type\" : \"User\",\n \"status\" : \"Unassigned\",\n \"profileImage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/3236457004/profile-image\",\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"put":{"tags":["User Settings"],"summary":"Update Extension","description":"Updates user settings.","operationId":"updateExtension","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Disabled","Enabled","NotActivated","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"reason":{"type":"string","description":"Type of suspension"},"comment":{"type":"string","description":"Free Form user comment"},"extensionNumber":{"type":"string","description":"Extension number available"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed"]},"partnerId":{"type":"string","description":"Additional extension identifier, created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"password":{"type":"string","description":"Password for extension"},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"transition":{"type":"object","items":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","DelegatedLinesGroup","GroupCallPickup"]},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"account":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"}},"description":"Account information"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"departments":{"type":"array","description":"Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","items":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"id":{"type":"string","description":"Internal identifier of a department extension"},"uri":{"type":"string","description":"Canonical URI of a department extension"},"extensionNumber":{"type":"string","description":"Number of a department extension"}}}},"extensionNumber":{"type":"string","description":"Number of extension"},"extensionNumbers":{"type":"array","items":{"type":"string"}},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"roles":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string"},"id":{"type":"string","description":"Internal identifier of a role"}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"serviceFeatures":{"type":"array","description":"Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features","items":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}}},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup).","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}}}}}},"x-api-group":"extension","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserInfo OR EditUserCredentials","x-feature":"EditExtensionInfo OR EditCredentials","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"title":"Update User Info","request":"PUT /restapi/v1.0/account/~/extension/~\n\n{\n \"contact\": {\n \"lastName\": \"Brown\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004\",\n \"id\": 871817004,\n \"extensionNumber\": \"101\",\n \"contact\": {\n \"firstName\": \"Alice\",\n \"lastName\": \"Brown\",\n \"company\": \"Example, Inc.\",\n \"email\": \"alice.smith@example.com\",\n \"businessPhone\": \"+12484897302\",\n \"businessAddress\": {\n \"street\": \"13 Elm Street\",\n \"city\": \"Foster City\",\n \"zip\": \"94404\",\n \"state\": \"CA\",\n \"country\": \"United States\"\n },\n \"emailAsLoginName\": true,\n \"pronouncedName\": {\n \"type\": \"Default\",\n \"text\": \"Alice Smith\"\n }\n },\n \"name\": \"Alice Smith\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"serviceFeatures\": [\n {\n \"featureName\": \"SMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SMSReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Pager\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PagerReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Voicemail\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Fax\",\n \"enabled\": true\n },\n {\n \"featureName\": \"FaxReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"DND\",\n \"enabled\": true\n },\n {\n \"featureName\": \"RingOut\",\n \"enabled\": true\n },\n {\n \"featureName\": \"InternationalCalling\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Presence\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VideoConferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SalesForce\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Intercom\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Paging\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"Conferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VoipCalling\",\n \"enabled\": true\n },\n {\n \"featureName\": \"FreeSoftPhoneLines\",\n \"enabled\": false,\n \"reason\": \"ExtensionLimitation\"\n },\n {\n \"featureName\": \"HipaaCompliance\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"CallPark\",\n \"enabled\": true\n },\n {\n \"featureName\": \"OnDemandCallRecording\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Reports\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallForwarding\",\n \"enabled\": true\n },\n {\n \"featureName\": \"DeveloperPortal\",\n \"enabled\": true\n },\n {\n \"featureName\": \"EncryptionAtRest\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"BlockedMessageForwarding\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"EmergencyCalling\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"HDVoice\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SingleExtensionUI\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"CallSupervision\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"VoicemailToText\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"WebPhone\",\n \"enabled\": true\n },\n {\n \"featureName\": \"RCTeams\",\n \"enabled\": true\n },\n {\n \"featureName\": \"UserManagement\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Calendar\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PasswordAuth\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallerIdControl\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticInboundCallRecording\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticOutboundCallRecording\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AutomaticCallRecordingMute\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"SoftPhoneUpdate\",\n \"enabled\": true\n },\n {\n \"featureName\": \"LinkedSoftphoneLines\",\n \"enabled\": false,\n \"reason\": \"AccountTypeLimitation\"\n },\n {\n \"featureName\": \"CallQualitySurvey\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"AccountFederation\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"MMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallParkLocations\",\n \"enabled\": true\n },\n {\n \"featureName\": \"ExternalDirectoryIntegration\",\n \"enabled\": false,\n \"reason\": \"AccountTypeLimitation\"\n },\n {\n \"featureName\": \"CallSwitch\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PromoMessage\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SiteCodes\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"InternationalSMS\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n }\n ],\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/14\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n },\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"12h\"\n },\n \"setupWizardState\": \"Completed\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": true\n },\n \"internationalCalling\": {\n \"enabled\": true\n }\n },\n \"profileImage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image\",\n \"etag\": \"7a1decb8efda89d7c0acff42f061d99d\",\n \"contentType\": \"image/gif\",\n \"lastModified\": \"2018-01-29T09:29:45.316Z\",\n \"scales\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/90x90\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/195x195\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/extension/871817004/profile-image/584x584\"\n }\n ]\n },\n \"account\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004\",\n \"id\": \"871817004\"\n },\n \"site\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/871817004/site/871836004\",\n \"id\": \"871836004\",\n \"name\": \"Store 7\"\n },\n \"hidden\": false\n}\n"},{"title":"Update Call Queue Settings","request":"PUT /restapi/v1.0/account/~/extension/404462943008\n\n{\n \"callQueueInfo\": {\n \"slaGoal\": 80,\n \"slaThresholdSeconds\": 60,\n \"includeAbandonedCalls\" : true,\n \"abandonedThresholdSeconds\": 60\n }\n}\n","response":"{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404462940008/extension/404462943008\",\n \"id\": 404462943008,\n \"extensionNumber\": \"201\",\n \"contact\": {\n \"firstName\": \"Sales\",\n \"lastName\": \"\",\n \"email\": \"sales@example.com\",\n \"pronouncedName\": {\n \"type\": \"Default\",\n \"text\": \"Sales\"\n }\n },\n \"name\": \"Sales\",\n \"type\": \"Department\",\n \"status\": \"Enabled\",\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/14\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n },\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"12h\"\n },\n \"setupWizardState\": \"NotStarted\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": false\n },\n \"internationalCalling\": {\n \"enabled\": false\n }\n },\n \"profileImage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404462940008/extension/404462943008/profile-image\"\n },\n \"callQueueInfo\": {\n \"slaGoal\": 80,\n \"slaThresholdSeconds\": 60,\n \"includeAbandonedCalls\": true,\n \"abandonedThresholdSeconds\": 60\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [contact.email] value is invalid."},{"httpCode":"400","errorCode":"PWD-002","message":"Password must contain at least one number"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]},"delete":{"tags":["User Settings"],"summary":"Delete Extension","description":"Deletes extension(s) by ID(s). When an extension is being deleted the default API behaviour is as follows: ⋅⋅* user's direct numbers are preserved by becoming additional company numbers; ⋅⋅* user's digital lines (both device & associated phone number) are deleted. You can change this behaviour using the filters: ..* create unassigned extensions for each digital line of the deleted extension by setting the query parameter `savePhoneLines` to `true` in request path; ..* remove direct numbers of the deleted extension by setting the query parameter `savePhoneNumbers` to `false` in request path","operationId":"deleteExtension","parameters":[{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"savePhoneLines","in":"query","schema":{"type":"boolean","default":false}},{"name":"savePhoneNumbers","in":"query","schema":{"type":"boolean","default":true}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"AddRemoveUsers","x-feature":"EditUsers","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/extension/404721119008?savePhoneNumbers=false&savePhoneLines=true\n","response":"HTTP 204 No Content\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"JWS-1736","message":"This mailbox has last device of SLG"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id":{"get":{"tags":["User Settings"],"summary":"Get Extension Caller ID","description":"Returns information on an outbound caller ID of an extension.","operationId":"readExtensionCallerId","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URL of a caller ID resource"},"byDevice":{"type":"array","items":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by device"}},"byFeature":{"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","enum":["RingOut","RingMe","CallFlip","FaxNumber","AdditionalSoftphone","Alternate","CommonPhone","MobileApp","Delegated"]},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by feature"}},"extensionNameForOutboundCalls":{"type":"boolean","description":"If 'True', then user first name and last name will be used as caller ID when making outbound calls from extension"},"extensionNumberForInternalCalls":{"type":"boolean","description":"If 'True', then extension number will be used as caller ID when making internal calls"}}}}}}},"x-api-group":"extension/caller-id","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCallerIDSettings","x-feature":"ReadOutboundCallerId","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/caller-id\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/400338298008/extension/400338298008/caller-id\",\n \"byFeature\": [\n {\n \"feature\": \"FaxNumber\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/phone-number/400338298008\",\n \"id\": \"400859646008\",\n \"phoneNumber\": \"+18662020433\"\n }\n }\n },\n {\n \"feature\": \"CallFlip\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"http:https://platform.ringcentral.com/restapi/v1.0/account/phone-number/400338298008\",\n \"id\": \"400859646008\",\n \"phoneNumber\": \"+18662020433\"\n }\n }\n },\n {\n \"feature\": \"RingOut\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"http:https://platform.ringcentral.com/restapi/v1.0/account/phone-number/400338298008\",\n \"id\": \"400859646008\",\n \"phoneNumber\": \"+18662020433\"\n }\n }\n },\n {\n \"feature\": \"RingMe\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/phone-number/400338298008\",\n \"id\": \"400859646008\",\n \"phoneNumber\": \"+18662020433\"\n }\n }\n },\n {\n \"feature\": \"Alternate\",\n \"callerId\": {}\n }\n ]\n}\n"}],"x-error-codes":null},"put":{"tags":["User Settings"],"summary":"Update Extension Caller ID","description":"Updates outbound caller ID information of an extension.","operationId":"updateExtensionCallerId","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URL of a caller ID resource"},"byDevice":{"type":"array","items":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by device"}},"byFeature":{"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","enum":["RingOut","RingMe","CallFlip","FaxNumber","AdditionalSoftphone","Alternate","CommonPhone","MobileApp","Delegated"]},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by feature"}},"extensionNameForOutboundCalls":{"type":"boolean","description":"If 'True', then user first name and last name will be used as caller ID when making outbound calls from extension"},"extensionNumberForInternalCalls":{"type":"boolean","description":"If 'True', then extension number will be used as caller ID when making internal calls"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URL of a caller ID resource"},"byDevice":{"type":"array","items":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Link to a device resource"},"name":{"type":"string","description":"Name of a device"}}},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by device"}},"byFeature":{"type":"array","items":{"type":"object","properties":{"feature":{"type":"string","enum":["RingOut","RingMe","CallFlip","FaxNumber","AdditionalSoftphone","Alternate","CommonPhone","MobileApp","Delegated"]},"callerId":{"type":"object","properties":{"type":{"type":"string","description":"If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation']"},"phoneInfo":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"},"uri":{"type":"string","description":"Link to a phone number resource"},"phoneNumber":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}}}}}},"description":"Caller ID settings by feature"}},"extensionNameForOutboundCalls":{"type":"boolean","description":"If 'True', then user first name and last name will be used as caller ID when making outbound calls from extension"},"extensionNumberForInternalCalls":{"type":"boolean","description":"If 'True', then extension number will be used as caller ID when making internal calls"}}}}}}},"x-api-group":"extension/caller-id","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditCallerIDSettings","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/caller-id\n\n{\n \"byDevice\": [\n {\n \"device\": {\n \"id\": \"240677004\"\n },\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n }\n ],\n \"byFeature\": [\n {\n \"feature\": \"CallFlip\",\n \"callerId\": {\n \"type\": \"Blocked\"\n }\n },\n {\n \"feature\": \"RingOut\",\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n },\n {\n \"feature\": \"RingMe\",\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n },\n {\n \"feature\": \"FaxNumber\",\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n },\n {\n \"feature\": \"Alternate\",\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n },\n {\n \"feature\": \"MobileApp\",\n \"callerId\": {\n \"phoneInfo\": {\n \"id\": \"1155244004\"\n }\n }\n }\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/extension/1465224004/caller-id\",\n \"byDevice\": [\n {\n \"device\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/device/240677004\",\n \"id\": \"240677004\",\n \"name\": \"Cisco SPA-303 Desk Phone\"\n },\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n }\n ],\n \"byFeature\": [\n {\n \"feature\": \"FaxNumber\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n },\n {\n \"feature\": \"CallFlip\",\n \"callerId\": {\n \"type\": \"Blocked\"\n }\n },\n {\n \"feature\": \"RingOut\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n },\n {\n \"feature\": \"RingMe\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n },\n {\n \"feature\": \"MobileApp\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n },\n {\n \"feature\": \"Alternate\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n },\n {\n \"feature\": \"AdditionalSoftphone\",\n \"callerId\": {\n \"type\": \"PhoneNumber\",\n \"phoneInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1465224004/phone-number/1155244004\",\n \"id\": \"1155244004\",\n \"phoneNumber\": \"+18002007739\"\n }\n }\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/grant":{"get":{"tags":["User Settings"],"summary":"Get Extension Grant List","description":"Returns the list of extensions with the information on grants given to the current extension regarding them. Currently the list of grants include: picking up a call, monitoring, calling or receiving a call on behalf of somebody, call delegation and calling paging groups.","operationId":"listExtensionGrants","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionType","in":"query","description":"Type of extension to be returned. Multiple values are supported. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","schema":{"type":"string","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Limited","Bot"]}},{"name":"page","in":"query","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","schema":{"type":"string","default":"100"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of extension grants"},"records":{"type":"array","description":"List of extension grants with details","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a grant"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Extension short number (usually 3 or 4 digits)"},"name":{"type":"string","description":"Name of extension"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation"]}},"description":"Extension information"},"callPickup":{"type":"boolean","description":"Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned"},"callMonitoring":{"type":"boolean","description":"Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned"},"callOnBehalfOf":{"type":"boolean","description":"Specifies whether the current extension is able to make or receive calls on behalf of the user referenced in extension object"},"callDelegation":{"type":"boolean","description":"Specifies whether the current extension can delegate a call to the user referenced in extension object"},"groupPaging":{"type":"boolean","description":"Specifies whether the current extension is allowed to call Paging Only group referenced to in extension object"},"callQueueSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Full-Access manager in the call queue referenced in extension object"},"callQueueMembersSetup":{"type":"boolean","description":"Specifies whether the current extension is assigned as a Members-Only manager in the call queue referenced in extension object"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/grant","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/grant?page=1&perPage=3\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant?page=1&perPage=3\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant/404288426008\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288426008\",\n \"extensionNumber\": \"102\",\n \"id\": \"404288426008\",\n \"type\": \"User\"\n },\n \"callPickup\": true,\n \"callMonitoring\": true,\n \"groupPaging\": false\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant/404288427008\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288427008\",\n \"extensionNumber\": \"103\",\n \"id\": \"404288427008\",\n \"type\": \"PagingOnly\"\n },\n \"callPickup\": false,\n \"callMonitoring\": false,\n \"groupPaging\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant/404288428008\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288428008\",\n \"extensionNumber\": \"104\",\n \"id\": \"404288428008\",\n \"type\": \"User\"\n },\n \"callPickup\": false,\n \"callMonitoring\": true,\n \"groupPaging\": false\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 2,\n \"perPage\": 3,\n \"totalElements\": 4,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"nextPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant?page=2&perPage=3\"\n },\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant?page=1&perPage=3\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404288424008/extension/404288424008/grant?page=2&perPage=3\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/users":{"get":{"tags":["Automatic Location Updates"],"summary":"Get User List","description":"Returns the list of users with their status of Automatic Location Updates feature.","operationId":"listAutomaticLocationUpdatesUsers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"type","in":"query","description":"Extension type. Multiple values are supported","schema":{"type":"string","enum":["User","Limited"]}},{"name":"searchString","in":"query","description":"Filters entries containing the specified substring in user name, extension or department. The characters range is 0-64; not case-sensitive. If empty then the filter is ignored","schema":{"type":"string"}},{"name":"department","in":"query","description":"Department name to filter the users. The value range is 0-64; not case-sensitive. If not specified then the parameter is ignored. Multiple values are supported","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Internal identifier of a site. To filter users of Main Site (Company) `main-site` must be specified. Supported only If Multi-Site feature is enabled for the account. Multiple values are supported","schema":{"type":"string"}},{"name":"featureEnabled","in":"query","description":"Filters entries by their status of Automatic Location Updates feature","schema":{"type":"boolean"}},{"name":"orderBy","in":"query","description":"Comma-separated list of fields to order results prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order). Supported values: 'name', 'modelName', 'siteName', 'featureEnabled'","schema":{"type":"string","default":"name"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are supported","schema":{"type":"integer","default":1}}],"responses":{"default":{"description":"User List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the users list resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"fullName":{"type":"string","description":"User name"},"extensionNumber":{"type":"string"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"type":{"type":"string","description":"User extension type","enum":["User","Limited"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"department":{"type":"string","description":"Department name"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-address-auto-update/users","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-team":"PLA Inno","x-availability":"High","x-docs-level":"Public","x-beta-api":true,"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [page] value is invalid."}]}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/users/bulk-assign":{"post":{"tags":["Automatic Location Updates"],"summary":"Enable Automatic Location Updates for Users","description":"Enables or disables Automatic Location Updates feature for multiple account users.","operationId":"assignMultipleAutomaticaLocationUpdatesUsers","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabledUserIds":{"type":"array","items":{"type":"string"}},"disabledUserIds":{"type":"array","items":{"type":"string"}}}}}},"required":false},"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/emergency-address-auto-update/users/bulk-assign","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Wireless Point List","description":"Returns account wireless points configured and used for Automatic Location Updates feature.","operationId":"listWirelessPoints","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"siteId","in":"query","description":"Internal identifier of a site. To filter Main Site (Company) 'main-site' must be specified. Supported only If multi-site feature is enabled for the account","schema":{"type":"string"}},{"name":"searchString","in":"query","description":"Filters entries by the specified substring (search by chassis ID, switch name or address) The characters range is 0-64 (if empty the filter is ignored)","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Comma-separated list of fields to order results prefixed by '+' sign (ascending order) or '-' sign (descending order). The default sorting is by `name`","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are supported","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Wireless Points","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point list resource"},"records":{"type":"array","description":"List of wireless points with assigned emergency addresses","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points?siteId=401182962008\n\n","response":"HTTP/1.1 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points?siteId=401182962008&orderBy=%2Bname&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2848008\",\n \"id\" : \"2848008\",\n \"bssid\" : \"B0:6E:BF:CC:6A:79\",\n \"name\" : \"Access point 1\",\n \"site\" : {\n \"id\" : \"401182962008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"5068008\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2849008\",\n \"id\" : \"2849008\",\n \"bssid\" : \"B0:6E:BF:CC:6A:75\",\n \"name\" : \"Access point 2\",\n \"site\" : {\n \"id\" : \"401182962008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"5068008\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points?siteId=401182962008&orderBy=%2Bname&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points?siteId=401182962008&orderBy=%2Bname&page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Automatic Location Updates"],"summary":"Create Wireless Point","description":"Creates a new wireless point in network configuration with the emergency address assigned.","operationId":"createWirelessPoint","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["bssid","emergencyAddress","name"],"type":"object","properties":{"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. The Mask is XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Wireless Point","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-team":"PLA Inno","x-http-examples":[{"request":"POST /restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points\n\n{\n \"bssid\":\"B0:6E:BF:CC:6A:67\",\n \"name\":\"Access point 3\",\n \"site\": {\"id\": \"401182962008\"},\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"App.139\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2852008\",\n \"id\" : \"2852008\",\n \"bssid\" : \"B0:6E:BF:CC:6A:67\",\n \"name\" : \"Access point 3\",\n \"site\" : {\n \"id\" : \"401182962008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"5068008\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Wireless Point","description":"Returns the specified wireless access point of a corporate map with the emergency address assigned.","operationId":"readWirelessPoint","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"pointId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Wireless Point","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2849008\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2849008\",\n \"id\" : \"2849008\",\n \"bssid\" : \"B0:6E:BF:CC:6A:75\",\n \"name\" : \"Access point 2\",\n \"site\" : {\n \"id\" : \"401182962008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"5068008\"\n}\n"}],"x-error-codes":null},"put":{"tags":["Automatic Location Updates"],"summary":"Update Wireless Point","description":"Updates the specified wireless access point of a corporate map by ID.","operationId":"updateWirelessPoint","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"pointId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. Mask: XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Wireless Point","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the wireless point resource"},"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2852008?siteId=401182962008\n\n{ \n \"bssid\":\"B0:6E:BF:CC:6E:75\",\n \"name\":\"Access point 10\",\n \"site\":{ \n \"id\":\"401182962008\",\n \"name\":\"West branch\"\n },\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"App.139\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2852008\",\n \"id\" : \"2852008\",\n \"bssid\" : \"B0:6E:BF:CC:6E:75\",\n \"name\" : \"Access point 10\",\n \"site\" : {\n \"id\" : \"401182962008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"5068008\"\n}\n``` \n\n# deleteWirelessPoint\n### Request\n```HTTP\nDELETE /restapi/v1.0/account/401180509008/emergency-address-auto-update/wireless-points/2846008\n"}],"x-error-codes":null},"delete":{"tags":["Automatic Location Updates"],"summary":"Delete Wireless Point","description":"Deletes wireless point(s) of a corporate map by ID(s).","operationId":"deleteWirelessPoint","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"pointId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/emergency-address-auto-update/wireless-points","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Network Map","description":"Returns corporate networks map with emergency addresses assigned to the current account.","operationId":"listNetworks","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Networks List","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a networks resource"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a network"},"uri":{"type":"string","description":"Link to a network resource"},"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-address-auto-update/networks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401325712008/emergency-address-auto-update/networks\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks?orderBy=%2Bname&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks/3313008\",\n \"id\" : \"3313008\",\n \"name\" : \"Main Office Network\",\n \"site\" : {\n \"id\" : \"401325717008\",\n \"name\" : \"Site\"\n },\n \"publicIpRanges\" : [ {\n \"id\" : \"7005008\",\n \"startIp\" : \"52.86.163.26\",\n \"endIp\" : \"52.86.163.26\"\n }, {\n \"id\" : \"7006008\",\n \"startIp\" : \"52.86.163.30\",\n \"endIp\" : \"52.86.163.35\"\n } ],\n \"privateIpRanges\" : [ {\n \"id\" : \"7007008\",\n \"startIp\" : \"192.168.13.1\",\n \"endIp\" : \"192.168.15.255\",\n \"name\" : \"1 floor west wing\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n }, {\n \"id\" : \"7008008\",\n \"startIp\" : \"10.0.0.7\",\n \"endIp\" : \"10.0.0.7\",\n \"name\" : \"CEO cabinet\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n } ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks?orderBy=%2Bname&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks?orderBy=%2Bname&page=1&perPage=100\"\n }\n }\n}\n\n"}],"x-error-codes":null},"post":{"tags":["Automatic Location Updates"],"summary":"Create Network","description":"Creates a new network in corporate ethernet map for assignment of emergency addresses to network access points.","operationId":"createNetwork","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Created Network","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a network"},"uri":{"type":"string","description":"Link to a network resource"},"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}},"x-api-group":"account/emergency-address-auto-update/networks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-team":"PLA Inno","x-http-examples":[{"request":"POST /restapi/v1.0/account/401325712008/emergency-address-auto-update/networks\n\n{ \n \"name\": \"Main Office Network\",\n \"site\": { \n \"id\":\"401325717008\"\n },\n \"publicIpRanges\":[ \n { \n \"startIp\":\"52.86.163.26\",\n \"endIp\":\"52.86.163.26\"\n },\n { \n \"startIp\":\"52.86.163.30\",\n \"endIp\":\"52.86.163.35\"\n }\n ],\n \"privateIpRanges\":[ \n { \n \"startIp\":\"192.168.13.1\",\n \"endIp\":\"192.168.15.255\",\n \"name\":\"1 Floor West Wing\",\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"1 Floor, West wing\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n },\n { \n \"startIp\":\"10.0.0.7\",\n \"endIp\":\"10.0.0.7\",\n \"name\":\"CEO Cabinet\",\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"13 Floor, 450\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n }\n ]\n }\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks/3313008\",\n \"id\" : \"3313008\",\n \"name\" : \"Main Office Network\",\n \"site\" : {\n \"id\" : \"401325717008\",\n \"name\" : \"Site\"\n },\n \"publicIpRanges\" : [ {\n \"id\" : \"7005008\",\n \"startIp\" : \"52.86.163.26\",\n \"endIp\" : \"52.86.163.26\"\n }, {\n \"id\" : \"7006008\",\n \"startIp\" : \"52.86.163.30\",\n \"endIp\" : \"52.86.163.35\"\n } ],\n \"privateIpRanges\" : [ {\n \"id\" : \"7007008\",\n \"startIp\" : \"192.168.13.1\",\n \"endIp\" : \"192.168.15.255\",\n \"name\" : \"1 Floor West Wing\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n }, {\n \"id\" : \"7008008\",\n \"startIp\" : \"10.0.0.7\",\n \"endIp\" : \"10.0.0.7\",\n \"name\" : \"CEO Cabinet\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n } ]\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Network","description":"Returns the specified network with emergency addresses assigned to the current account.","operationId":"readNetwork","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"networkId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Network information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a network"},"uri":{"type":"string","description":"Link to a network resource"},"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"matched":{"type":"boolean"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}},"x-api-group":"account/emergency-address-auto-update/networks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401325712008/emergency-address-auto-update/networks/3313008\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401325712008/emergency-address-auto-update/networks/3313008\",\n \"id\" : \"3313008\",\n \"name\" : \"Main Office Network\",\n \"site\" : {\n \"id\" : \"401325717008\",\n \"name\" : \"Site\"\n },\n \"publicIpRanges\" : [ {\n \"id\" : \"7005008\",\n \"startIp\" : \"52.86.163.26\",\n \"endIp\" : \"52.86.163.26\"\n }, {\n \"id\" : \"7006008\",\n \"startIp\" : \"52.86.163.30\",\n \"endIp\" : \"52.86.163.35\"\n } ],\n \"privateIpRanges\" : [ {\n \"id\" : \"7007008\",\n \"startIp\" : \"192.168.13.1\",\n \"endIp\" : \"192.168.15.255\",\n \"name\" : \"1 floor west wing\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n }, {\n \"id\" : \"7008008\",\n \"startIp\" : \"10.0.0.7\",\n \"endIp\" : \"10.0.0.7\",\n \"name\" : \"CEO cabinet\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"5095008\"\n } ]\n}\n\n"}],"x-error-codes":null},"put":{"tags":["Automatic Location Updates"],"summary":"Update Network","description":"Updates network in corporate ethernet map for assignment of emergency addresses to network access points.","operationId":"updateNetwork","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"networkId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"publicIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"matched":{"type":"boolean"}}}},"privateIpRanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"startIp":{"type":"string"},"endIp":{"type":"string"},"name":{"type":"string","description":"Network name"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{}}},"x-api-group":"account/emergency-address-auto-update/networks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/401492767008/emergency-address-auto-update/networks/4001008\n\n{ \n \"name\": \"Office Network #2\",\n \"site\": { \n \"id\":\"401492773008\"\n },\n \"publicIpRanges\":[ \n { \n \"startIp\":\"52.86.163.26\",\n \"endIp\":\"52.86.163.26\"\n },\n { \n \"startIp\":\"52.86.163.30\",\n \"endIp\":\"52.86.163.35\"\n }\n ],\n \"privateIpRanges\":[ \n { \n \"startIp\":\"192.168.13.1\",\n \"endIp\":\"192.168.15.255\",\n \"name\":\"2 Floor West Wing\",\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"2 Floor, West wing\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n },\n { \n \"startIp\":\"10.0.0.7\",\n \"endIp\":\"10.0.0.7\",\n \"name\":\"Library\",\n \"emergencyAddress\":{ \n \"street\":\"13 Elm Street\",\n \"street2\":\"13 Floor, 450\",\n \"city\":\"Foster City\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n }\n ]\n }\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401492767008/emergency-address-auto-update/networks/4001008\",\n \"id\" : \"4001008\",\n \"name\" : \"Office Network #2\",\n \"site\" : {\n \"id\" : \"401492773008\",\n \"name\" : \"Site\"\n },\n \"publicIpRanges\" : [ {\n \"id\" : \"8629008\",\n \"startIp\" : \"52.86.163.26\",\n \"endIp\" : \"52.86.163.26\"\n }, {\n \"id\" : \"8630008\",\n \"startIp\" : \"52.86.163.30\",\n \"endIp\" : \"52.86.163.35\"\n } ],\n \"privateIpRanges\" : [ {\n \"id\" : \"8631008\",\n \"startIp\" : \"192.168.13.1\",\n \"endIp\" : \"192.168.15.255\",\n \"name\" : \"2 Floor West Wing\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"6501008\"\n }, {\n \"id\" : \"8632008\",\n \"startIp\" : \"10.0.0.7\",\n \"endIp\" : \"10.0.0.7\",\n \"name\" : \"Library\",\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"6501008\"\n } ]\n}\n\n"}],"x-error-codes":null},"delete":{"tags":["Automatic Location Updates"],"summary":"Delete Network","description":"Deletes network(s) in corporate ethernet map for Automatic Location Updates feature.","operationId":"deleteNetwork","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"networkId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/emergency-address-auto-update/networks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/401492767008/emergency-address-auto-update/networks/4001008\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Device List","description":"Returns the list of common devices with their status of Automatic Location Updates feature.","operationId":"listDevicesAutomaticLocationUpdates","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"siteId","in":"query","description":"Internal identifier of a site. To filter devices of Main Site (Company) `main-site` must be specified. Supported only If Multi-Site feature is enabled for the account","schema":{"type":"string"}},{"name":"featureEnabled","in":"query","description":"Filters entries by their status of Automatic Location Updates feature","schema":{"type":"boolean"}},{"name":"model","in":"query","description":"Internal identifier of a device model for filtering. Multiple values are supported","schema":{"type":"string"}},{"name":"compatibleOnly","in":"query","description":"Filters devices which support HELD protocol","schema":{"type":"boolean"}},{"name":"searchString","in":"query","description":"Filters entries which have device name or model name containing the mentioned substring. The value should be split by spaces; the range is 0 - 64 characters, not case-sensitive. If empty the filter is ignored","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Comma-separated list of fields to order results prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order). Supported values: 'name', 'modelName', 'siteName', 'featureEnabled'","schema":{"type":"string","default":"name"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are supported","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Device List with their status of Automatic Location Updates feature","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to devices resource"},"records":{"type":"array","description":"List of users' devices with the current status of Emergency Address Auto Update Feature","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["HardPhone","SoftPhone","OtherPhone"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned)"},"featureEnabled":{"type":"boolean","description":"Specifies if Automatic Location Updates feature is enabled"},"name":{"type":"string","description":"Device name"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Device model identifier"},"name":{"type":"string","description":"Device name"},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","Intercom","Paging","HELD"]}}},"description":"HardPhone model information"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"lineType":{"type":"string","enum":["Unknown","Standalone","StandaloneFree","BlaPrimary","BlaSecondary","BLF"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number"},"phoneNumber":{"type":"string","description":"Phone number"}}}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-address-auto-update/devices","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-team":"PLA Inno","x-availability":"High","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/406609622044/emergency-address-auto-update/devices\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/406609622044/emergency-address-auto-update/devices?orderBy=%2Bname&page=1&perPage=100\",\n \"records\" : [\n\n\n { \n \"id\": \"16123976020\",\n \"type\": \"OtherPhone\",\n \"name\": \"Existing device\",\n \"status\": \"Offline\",\n \"shared\": true,\n \"featureEnabled\": true,\n \"inCompanyNet\": true,\n \"phoneLines\": [ \n { \n \"lineType\":\"Standalone\",\n \"emergencyAddress\": { \n \"required\": true,\n \"localOnly\": false\n },\n \"phoneInfo\": { \n \"id\":\"1879006020\",\n \"phoneNumber\": \"+16507628967\",\n \"country\": { \n \"id\": \"1\",\n \"name\": \"United States\"\n }\n }\n }\n ],\n \"emergencyServiceAddress\": { \n \"street\": \"1502 W HILLSDALE BLVD\",\n \"city\": \"SAN MATEO\",\n \"state\": \"CA\",\n \"stateId\": \"16\",\n \"stateIsoCode\": \"CA\",\n \"stateName\": \"California\",\n \"country\": \"US\",\n \"countryId\": \"1\",\n \"countryIsoCode\": \"US\",\n \"countryName\": \"United States\",\n \"zip\": \"94402\",\n \"customerName\": \"John Smith\"\n }\n }\n ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/406609622044/emergency-address-auto-update/devices?orderBy=%2Bname&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/406609622044/emergency-address-auto-update/devices?orderBy=%2Bname&page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices/bulk-assign":{"post":{"tags":["Automatic Location Updates"],"summary":"Enable Automatic Location Updates for Devices","description":"Enables or disables Automatic Location Updates feature for the specified common phones.","operationId":"assignMultipleDevicesAutomaticLocationUpdates","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabledDeviceIds":{"type":"array","items":{"type":"string","description":"List of common devices for feature activation"}},"disabledDeviceIds":{"type":"array","items":{"type":"string","description":"List of common devices for feature disabling"}}}}}},"required":false},"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/emergency-address-auto-update/devices/bulk-assign","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/emergency-address-auto-update/devices/bulk-assign\n \n {\n \"enabledDeviceIds\": \n [\n \"402731886008\", \"402731889008\"\n ],\n \"disabledDeviceIds\": \n [\n \"402731883008\", \"402731887008\"\n ]\n}\n","response":"HTTP 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Account Switch List","description":"Returns corporate map of configured network switches with the assigned emergency addresses for the logged-in account.","operationId":"listAccountSwitches","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"siteId","in":"query","description":"Internal identifier of a site. To filter Main Site (Company) main-site must be specified. Supported only If multi-site feature is enabled for the account","schema":{"type":"string"}},{"name":"searchString","in":"query","description":"Filters entries by the specified substring (search by chassis ID, switch name or address) The characters range is 0-64 (if empty the filter is ignored)","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Comma-separated list of fields to order results prefixed by '+' sign (ascending order) or '-' sign (descending order). The default sorting is by `name`","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are supported","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Switches Map","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the switches list resource"},"records":{"type":"array","description":"Switches map","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401568934008/emergency-address-auto-update/switches\n","response":"HTTP/1.1 200 OK\n\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches?orderBy=%2Bname&page=1&perPage=100\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\",\n \"id\" : \"5461008\",\n \"chassisId\" : \"192.168.5.9\",\n \"name\" : \"Building 1 Floor 13\",\n \"site\" : {\n \"id\" : \"401592370008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"6502008\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5462008\",\n \"id\" : \"5462008\",\n \"chassisId\" : \"192.168.5.7\",\n \"name\" : \"Building 2 Floor 13\",\n \"site\" : {\n \"id\" : \"401592370008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"6502008\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches?orderBy=%2Bname&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches?orderBy=%2Bname&page=1&perPage=100\"\n }\n }\n}\n\n"}],"x-error-codes":null},"post":{"tags":["Automatic Location Updates"],"summary":"Create Switch","description":"Creates a new switch in corporate map based on chassis ID and used for Automatic Locations Update feature.","operationId":"createSwitch","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["chassisId"],"type":"object","properties":{"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Switch information","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/401568934008/emergency-address-auto-update/switches\n\n{ \n \n \"chassisId\":\"192.168.5.9\",\n \"name\":\"Building 1 Floor 13\",\n \"site\": \n {\"id\": \"401592370008\" },\n \"emergencyAddress\":{ \n \"street\":\"13 ELM STREET\",\n \"street2\":\"1 FLR, WEST WING\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\",\n \"id\" : \"5461008\",\n \"chassisId\" : \"192.168.5.9\",\n \"name\" : \"Building 1 Floor 13\",\n \"site\" : {\n \"id\" : \"401592370008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"6502008\"\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Switch","description":"Returns the specified switch with the assigned emergency address.","operationId":"readSwitch","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"switchId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Switch information","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-availablity":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\",\n \"id\" : \"5461008\",\n \"chassisId\" : \"192.168.5.9\",\n \"name\" : \"Building 1 Floor 13\",\n \"site\" : {\n \"id\" : \"401592370008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\"\n },\n \"emergencyLocationId\" : \"6502008\"\n}\n\n"}],"x-error-codes":null},"put":{"tags":["Automatic Location Updates"],"summary":"Update Switch","description":"Updates switch. Partial update is not supported, all switch parameters should be specified. If null value is received or parameter is missing, its value is removed.","operationId":"updateSwitch","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"switchId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}},"required":true},"responses":{"200":{"description":"Switch information","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\n\n{ \n \"id\": \"5461008\", \n \"chassisId\":\"192.168.5.9\",\n \"name\":\"Building 5 Floor 17\",\n \"site\": \n {\"id\": \"401592360008\" },\n \"emergencyAddress\":\n { \n \"street\":\"13 ELM STREET\",\n \"street2\":\"1 FLR, WEST WING\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n}\n","response":"HTTP 200 OK\n\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\",\n \"id\" : \"5461008\",\n \"chassisId\" : \"192.168.5.9\",\n \"name\" : \"Building 5 Floor 17\",\n \"site\" : {\n \"id\" : \"401592360008\",\n \"name\" : \"Site\"\n },\n \"emergencyAddress\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n },\n \"emergencyLocationId\" : \"6503008\"\n}\n\n"}],"x-error-codes":null},"delete":{"tags":["Automatic Location Updates"],"summary":"Delete Switch","description":"Deletes wireless switch(es) in network configuration for Automatic Location Updates feature.","operationId":"deleteSwitch","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}},{"name":"switchId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/emergency-address-auto-update/switches","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"DELETE /restapi/v1.0/account/401568934008/emergency-address-auto-update/switches/5461008\n\n","response":"204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-create":{"post":{"tags":["Automatic Location Updates"],"summary":"Create Multiple Switches","description":"Creates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000.","operationId":"createMultipleSwitches","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"required":["chassisId"],"type":"object","properties":{"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}}},"required":true},"responses":{"202":{"description":"Multiple Switches Creation Task","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple switches update"}},"description":"Information on the task for multiple switches creation"}}}}},"x-api-group":"account/emergency-address-auto-update/switches-bulk-create","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/emergency-address-auto-update/switches-bulk-create\n{ \n \"records\":[ \n { \n \"chassisId\":\"192.168.5.4\",\n \"name\":\"Building 1 Floor #1\",\n \"site\":{ \n \"id\":\"12345678\"\n },\n \"emergencyAddress\":{ \n \"street\":\"13 ELM STREET\",\n \"street2\":\"1 FLR, WEST WING\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n },\n { \n \"chassisId\":\"13:38:56:FF:90:AB\",\n \"name\":\"Building 2 Floor #2\",\n \"emergencyAddress\":{ \n \"street\":\"15 ELM STREET\",\n \"street2\":\"2 FLR\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n }\n ]\n}\n","response":" HTTP 202 Accepted \n{ \n \"task\" : { \n \"id\" : \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"status\" : \"Accepted\", \n \"creationTime\" : \"2019-02-20T13:30:09Z\", \n \"lastModifiedTime\" : \"2019-02-20T13:30:09Z\" \n } \n} \n\n Task Result Example\n{ \n \"result\":{ \n \"records\":[ \n { \n \"chassisId\":\"192/168/5/4\",\n \"status\":\"CreationFailed\",\n \"errors\":[ \n { \n \"errorCode\":\"CMN-101\",\n \"message\":\"Parameter [chassisId] value is invalid\",\n \"parameterName\":\"chassisId\"\n },\n { \n \"errorCode\":\"EME-201\",\n \"message\":\" Address validation failed: Location is not geocoded\",\n \"description\":\"Location is not geocoded\"\n }\n ]\n },\n { \n \"id\":\"54651522\",\n \"chassisId\":\"13:38:56:FF:90:AB\",\n \"status\":\"Created\"\n }\n ]\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-update":{"post":{"tags":["Automatic Location Updates"],"summary":"Update Multiple Switches","description":"Updates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000.","operationId":"updateMultipleSwitches","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}}},"required":true},"responses":{"202":{"description":"Multiple Switches Update Task","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple switches update"}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches-bulk-update","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/emergency-address-auto-update/switches-bulk-update\n{ \n \"records\":[ \n { \n \"id\":\"54651511\",\n \"chassisId\":\"192.168.5.4\",\n \"name\":\"Building 1 Floor 1\",\n \"site\":{ \n \"id\":\"12345678\"\n },\n \"emergencyAddress\":{ \n \"street\":\"13 ELM STREET\",\n \"street2\":\"1 FLR, WEST WING\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n },\n { \n \"id\":\"54651512\",\n \"chassisId\":\"13:38:56:FF:90:AB\",\n \"name\":\"Building 2\",\n \"emergencyAddress\":{ \n \"street\":\"15 ELM STREET\",\n \"street2\":\"2 FLR\",\n \"city\":\"FOSTER CITY\",\n \"state\":\"CA\",\n \"country\":\"US\",\n \"zip\":\"94404\"\n }\n }\n ]\n}\n","response":"HTTP 202 Accepted \n\n{ \n \"task\" : { \n \"id\" : \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"status\" : \"Accepted\", \n \"creationTime\" : \"2019-02-20T13:30:09Z\", \n \"lastModifiedTime\" : \"2019-02-20T13:30:09Z\"\n } \n} \n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create":{"post":{"tags":["Automatic Location Updates"],"summary":"Create Multiple Wireless Points","description":"Creates multiple wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000.","operationId":"createMultipleWirelessPoints","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"required":["bssid","emergencyAddress","name"],"type":"object","properties":{"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. The Mask is XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}}},"required":true},"responses":{"202":{"description":"Multiple Wireless Points Creation Task","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points creation"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points-bulk-create","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update":{"post":{"tags":["Automatic Location Updates"],"summary":"Update Multiple Wireless Points","description":"Updates wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000.","operationId":"updateMultipleWirelessPoints","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of wireless access point complying with MAC address conventions. Mask: XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Internal identifier of the emergency response location (address). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}}},"required":true},"responses":{"202":{"description":"Multiple Wireless Points Update Task","content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task for multiple switches creation"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"}},"description":"Information on the task for multiple wireless points update"}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points-bulk-update","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate":{"post":{"tags":["Automatic Location Updates"],"summary":"Validate Multiple Wireless Points","description":"Validates wireless points before creation or update. The maximum number of wireless points per request is 10 000.","operationId":"validateMultipleWirelessPoints","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"name":{"type":"string","description":"Wireless access point name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address assigned to the switch. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"}}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a wireless point"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}}}}}}}}},"x-api-group":"account/emergency-address-auto-update/wireless-points-bulk-validate","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-validate":{"post":{"tags":["Automatic Location Updates"],"summary":"Validate Multiple Switches","description":"Validates switches before creation or update. The maximum number of switches per request is 10 000.","operationId":"validateMultipleSwitches","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the network switch resource"},"id":{"type":"string","description":"Internal identifier of a network switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"name":{"type":"string","description":"Name of a network switch"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site. The company identifier value is 'main-site'"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"emergencyAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"customerName":{"type":"string","description":"Customer name"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"}},"description":"Emergency address information (or information assigned to the switch or wireless point - in case of using them). Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocationId":{"type":"string","description":"Deprecated. Emergency response location (address) internal identifier. Only one of a pair `emergencyAddress` or `emergencyLocationId` should be specified, otherwise the error is returned"},"emergencyLocation":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an emergency response location"},"name":{"type":"string","description":"Emergency response location name"}},"description":"Emergency response location information"}}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a switch"},"chassisId":{"type":"string","description":"Unique identifier of a network switch"},"status":{"type":"string","description":"Validation result status","enum":["Valid","Invalid"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"featureName":{"type":"string"},"parameterValue":{"type":"string"}}}}}}}}}}}}},"x-api-group":"account/emergency-address-auto-update/switches-points-bulk-validate","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditHardPhoneAutoLocationUpdate","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-availability":"High","x-team":"PLA Inno","x-codegen-request-body-name":"body","x-request-max-body-size":"100m","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-address-auto-update/tasks/{taskId}":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Emergency Map Configuration Task","description":"Returns results of the task created within the frame of Automatic Location Updates feature. Currently four task types are supported: 'Wireless Points Bulk Create', 'Wireless Points Bulk Update', 'Switches Bulk Create', 'Switches Bulk Update'.","operationId":"readAutomaticLocationUpdatesTask","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Task Information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"status":{"type":"string","description":"Status of a task","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the task latest modification"},"type":{"type":"string","description":"Type of a task","enum":["WirelessPointsBulkCreate","WirelessPointsBulkUpdate","SwitchesBulkCreate","SwitchesBulkUpdate"]},"result":{"type":"object","properties":{"records":{"type":"array","description":"Detailed task results by elements from initial request","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the created/updated element - wireless point or network switch"},"bssid":{"type":"string","description":"Unique 48-bit identifier of the wireless access point complying with MAC address conventions. Returned only for 'Wireless Points Bulk Create' tasks"},"chassisId":{"type":"string","description":"Unique identifier of a network switch. Returned only for 'Switches Bulk Create' tasks"},"status":{"type":"string","description":"Operation status"},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"parameterName":{"type":"string"},"description":{"type":"string"}}}}}}}},"description":"Task detailed result. Returned for failed and completed tasks"}}}}}}},"x-api-group":"account/emergency-address-auto-update/tasks","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Light","x-docs-level":"Public","x-availability":"High","x-team":"PLA Inno","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/emergency-address-auto-update/tasks/402297343008f674e48cbb5a479bac124ca8afcffb3d\n","response":"HTTP 200 OK\n\n{ \n \"task\":{ \n \"id\": \"402297343008f674e48cbb5a479bac124ca8afcffb3d\",\n \"status\": \"Completed\",\n \"creationTime\": \"2019-02-20T13:30:09Z\",\n \"lastModifiedTime\": \"2019-02-20T13:30:09Z\",\n \"type\": \"WirelessPointsBulkCreate\",\n \"result\": { \n \"records\":[ \n { \n \"bssid\": \"B0:6E:BF:CC:6E:75X\",\n \"status\": \"Failed\",\n \"errors\":[ \n { \n \"errorCode\": \"CMN-101\",\n \"message\": \"Parameter [bssid] value is invalid\",\n \"parameterName\": \"bssid\"\n },\n { \n \"errorCode\": \"EME-201\",\n \"message\": \"Address validation failed: Location is not geocoded\",\n \"description\": \"Location is not geocoded\"\n }\n ]\n },\n { \n \"id\": \"54651522\",\n \"bssid\": \"13:38:56:FF:90:AB\",\n \"status\": \"Completed\"\n }\n ]\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-locations":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Emergency Location List","description":"Returns emergency response locations of the current account.","operationId":"listEmergencyLocations","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"searchString","in":"query","description":"Filters entries containing the specified substring in address and name fields. The characters range is 0-64; not case-sensitive. If empty then the filter is ignored","schema":{"type":"string"}},{"name":"siteId","in":"query","description":"Internal identifier of a site for filtering. To filter by Main Site (Company) `main-site` value should be specified","schema":{"type":"string"}},{"name":"addressStatus","in":"query","schema":{"type":"string","enum":["Valid","Invalid"]}},{"name":"usageStatus","in":"query","schema":{"type":"string","enum":["Active","Inactive"]}},{"name":"domesticCountryId","in":"query","schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Comma-separated list of fields to order results prefixed by plus sign '+' (ascending order) or minus sign '-' (descending order). Supported values: 'address'","schema":{"type":"string","default":"address"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are supported","schema":{"type":"integer","default":1}}],"responses":{"200":{"description":"Emergency Location List","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/emergency-locations","x-app-permission":"ReadAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"ReadCompanyInfo","x-throttling-group":"Light","x-availability":"High","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/400531124008/emergency-locations?page=1&perPage=100&searchString=Smith&addressStatus=Valid&usageStatus=Active&domesticCountryId=1\n\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400531124008/emergency-locations?orderBy=%2Baddress&page=1&perPage=100\",\n \"records\" : [ {\n \"id\" : \"1203008\",\n \"name\": \"Headquaters. Floor 1\",\n \"site\": {\n \"id\": \"1265444\",\n \"name\": \"Headquaters\"\n },\n \"addressStatus\": \"Valid\",\n \"usageStatus\": \"Active\",\n \"visibility\": \"Public\",\n \"address\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n }\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400531124008/emergency-locations?orderBy=%2Baddress&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/400531124008/emergency-locations?orderBy=%2Baddress&page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Automatic Location Updates"],"summary":"Add Emergency Location","operationId":"createEmergencyLocation","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{}}},"x-api-group":"account/emergency-locations","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate","x-throttling-group":"Medium","x-team":"PLA Inno","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/400531124008/emergency-locations\n\n{\n \"name\": \"Headquaters. Floor 1\",\n \"site\": {\n \"id\": \"1265444\"\n },\n \"visibility\": \"Private\",\n \"owners\": [\n {\n \"id\": \"564541541\"\n },\n {\n \"id\": \"454451554\"\n }\n ],\n \"address\": {\n \"street\": \" 12 Street , 138\",\n \"street2\": \" App. 43\",\n \"city\": \"Belmont\",\n \"stateId\": \"16\",\n \"state\": \"CA\",\n \"countryId\": \"1\",\n \"country\": \"US\",\n \"zip\": \"123456\",\n \"customerName\": \"Customer Name\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"1203008\",\n \"address\" : {\n \"street\":\" 12 Street , 138 E\",\n \"street2\":\" App. 43\",\n \"city\":\"New York\",\n \"state\":\"NY\",\n \"country\":\"US\",\n \"zip\":\"10003\"\n \"stateId\" : \"44\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/emergency-locations/{locationId}":{"get":{"tags":["Automatic Location Updates"],"summary":"Get Emergency Location","description":"Returns emergency response location by ID.","operationId":"readEmergencyLocation","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"locationId","in":"path","description":"Internal identifier of the emergency location","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Emergency Location Information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"}}}}},"x-api-group":"account/emergency-locations","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate OR ReadEmergencyLocations","x-throttling-group":"Light","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/account/400531124008/emergency-locations/1203008\n","response":"HTTP 200 OK\n\n\n{\n \"id\" : \"1203008\",\n \"address\" : {\n \"street\" : \"20 DVS DRIVE\",\n \"city\" : \"BELMONT\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94002\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n }\n}\n\n\n"}],"x-error-codes":null},"put":{"tags":["Automatic Location Updates"],"summary":"Update Emergency Location","description":"Updates the specified emergency response location.","operationId":"updateEmergencyLocation","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"locationId","in":"path","description":"Internal identifier of the emergency location","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}}}}},"required":true},"responses":{"200":{"description":"Emergency Location Information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"address":{"type":"object","properties":{"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"countryName":{"type":"string","description":"Full name of a country"},"state":{"type":"string","description":"State/Province name. Mandatory for the USA, the UK and Canada"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"city":{"type":"string","description":"City name"},"street":{"type":"string","description":"First line address"},"street2":{"type":"string","description":"Second line address (apartment, suite, unit, building, floor, etc.)"},"zip":{"type":"string","description":"Postal (Zip) code"},"customerName":{"type":"string","description":"Customer name"}}},"name":{"type":"string","description":"Emergency response location name"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"name":{"type":"string","description":"Extension user first name"}}},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"usageStatus":{"type":"string","description":"Status of emergency response location usage.","enum":["Active","Inactive"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","ActivationProcess","Unsupported","Failed"]},"visibility":{"type":"string","description":"Visibility of an emergency response location. If `Private` is set, then location is visible only for restricted number of users, specified in `owners` array","default":"Public","enum":["Private","Public"]},"owners":{"type":"array","description":"List of private location owners","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user - private location owner"}}}}},"description":"Company emergency response location details"}}}}},"x-api-group":"account/emergency-locations","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-feature":"EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate OR EditEmergencyLocations","x-throttling-group":"Heavy","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/400531124008/emergency-locations/1203008\n\n{ \n \"address\":\n {\n \"street\" : \"13 Elm Street\",\n \"city\" : \"Foster City\",\n \"state\" : \"CA\",\n \"zip\" : \"94404\",\n \"country\" : \"US\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"1203008\",\n \"address\" : {\n \"street\" : \"13 Elm Street\",\n \"city\" : \"Foster City\",\n \"stateId\" : \"16\",\n \"stateName\" : \"California\",\n \"state\" : \"CA\",\n \"zip\" : \"94404\",\n \"countryId\" : \"1\",\n \"countryName\" : \"United States\",\n \"country\" : \"US\",\n \"customerName\" : \"John Smith\"\n }\n}\n\n"}],"x-error-codes":null},"delete":{"tags":["Automatic Location Updates"],"operationId":"deleteEmergencyLocation","summary":"Delete Emergency Location","description":"Deletes the specified emergency response location.","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"locationId","in":"path","description":"Internal identifier of emergency location","required":true,"schema":{"type":"string"}},{"name":"newLocationId","in":"query","description":"Internal identifier of a location that should be used instead of a deleted one","schema":{"type":"string"}},{"name":"validateOnly","in":"query","description":"Flag indicating that validation of emergency location(s) is required before deletion","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful validation","content":{}},"204":{"description":"No Content","content":{}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"object","properties":{"deletion":{"type":"string","enum":["Forbidden","Restricted","Allowed"]},"reassignment":{"type":"string","enum":["Forbidden","Allowed"]},"emergencyLocations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"deletion":{"type":"string","description":"Identifies the possibility and status of emergency location deletion","enum":["Failed","Completed","Forbidden","Restricted","Allowed"]},"errors":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"additionalInfo":{"type":"string","description":"Additional attribute for this error, for example `parameterName`"}}}}}}}}}}}},"x-api-group":"account/emergency-locations","x-app-permission":"EditAccounts","x-user-permission":"ConfigureEmergencyMaps","x-throttling-group":"Heavy","x-feature":"EditEmergencyLocations","x-docs-level":"Public","x-http-examples":[{"title":"204 No Content","request":"DELETE /restapi/v1.0/account/~/emergency-locations/850032,850055?newLocationId=8422254\n\n","response":"HTTP 204 No Content\n\n"},{"title":"207 Multi-Status","request":"DELETE /restapi/v1.0/account/~/emergency-locations/850032,850055?newLocationId=8422254\n\n","response":"HTTP 207 Multi-Status\nContent-Type: application/json\n{\n \"emergencyLocations\": [\n {\n \"id\": \"54651511\",\n \"name\": \"Reception\",\n \"deletion\": \"Failed\",\n \"errors\": [\n {\n \"errorCode\": \"EME-xxx\",\n \"message\": \"Emergency response location [${locationId}] cannot be deleted because it was recently referenced in an emergency call\"\n }\n ]\n },\n {\n \"id\": \"64616514\",\n \"name\": \"Accounting\",\n \"deletion\": \"Completed\"\n }\n ]\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations":{"get":{"tags":["Automatic Location Updates"],"summary":"Get User Emergency Location List","description":"Returns a list of emergency response locations available for the current user extension.","operationId":"getExtensionEmergencyLocations","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"User Emergency Location List","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}}}}}}},"x-api-group":"extension/emergency-locations","x-app-permission":"ReadAccounts","x-throttling-group":"Light","x-availability":"High","x-team":"PLA Inno","x-docs-level":"Public","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings":{"get":{"tags":["User Settings"],"summary":"Get Notification Settings","description":"Returns notification settings for the current extension.\n

Knowledge Article: User Settings - Set up Message Notifications

","operationId":"readNotificationSettings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of notifications settings resource"},"emailRecipients":{"type":"array","description":"List of extensions specified as email notification recipients. Returned only for call queues where queue managers are assigned as user extensions.","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"fullName":{"type":"string","description":"User full name"},"extensionNumber":{"type":"string","description":"User extension number"},"status":{"type":"string","description":"Current state of an extension","enum":["Enabled","Disable","NotActivated","Unassigned"]},"emailAddresses":{"type":"array","description":"List of user email addresses from extension notification settings. By default main email address from contact information is returned","items":{"type":"string"}},"permission":{"type":"string","description":"Call queue manager permission","enum":["FullAccess","MembersOnly"]}}}},"emailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"smsEmailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"advancedMode":{"type":"boolean","description":"Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied "},"voicemails":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"inboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"outboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"inboundTexts":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"missedCalls":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}}}}}}}},"x-api-group":"extension/notification-settings","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadMessagesNotificationsSettings","x-feature":"ReadMessageAndNotificationSettings","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/notification-settings\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/3446651004/extension/3446651004/notification-settings\",\n \"emailAddresses\": [\n \"alice.smith@example.com\",\n \"bob.johnson@example.com\"\n ],\n \"advancedMode\": true,\n \"voicemails\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": false,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"inboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"outboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"inboundTexts\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"missedCalls\": {\n \"notifyByEmail\": false,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n }\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [ReadAccounts] permission"},{"httpCode":"403","errorCode":"CMN-408","message":"In order to call this API endpoint, user needs to have [ReadMessagesNotificationsSettings] permission."}]},"put":{"tags":["User Settings"],"summary":"Update Notification Settings","description":"Updates notification settings for the current extension.\n

Knowledge Article: User Settings - Set up Message Notifications

","operationId":"updateNotificationSettings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"smsEmailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"advancedMode":{"type":"boolean","description":"Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied "},"voicemails":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"inboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"outboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"inboundTexts":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"missedCalls":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of notifications settings resource"},"emailRecipients":{"type":"array","description":"List of extensions specified as email notification recipients. Returned only for call queues where queue managers are assigned as user extensions.","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"fullName":{"type":"string","description":"User full name"},"extensionNumber":{"type":"string","description":"User extension number"},"status":{"type":"string","description":"Current state of an extension","enum":["Enabled","Disable","NotActivated","Unassigned"]},"emailAddresses":{"type":"array","description":"List of user email addresses from extension notification settings. By default main email address from contact information is returned","items":{"type":"string"}},"permission":{"type":"string","description":"Call queue manager permission","enum":["FullAccess","MembersOnly"]}}}},"emailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"smsEmailAddresses":{"type":"array","description":"List of notification recipient email addresses","items":{"type":"string"}},"advancedMode":{"type":"boolean","description":"Specifies notifications settings mode. If 'True' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If 'False' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied "},"voicemails":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether voicemail should be attached to email"},"includeTranscription":{"type":"boolean","description":"Specifies whether to add voicemail transcription or not"},"markAsRead":{"type":"boolean","description":"Indicates whether a voicemail should be automatically marked as read"}}},"inboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"includeAttachment":{"type":"boolean","description":"Indicates whether fax should be attached to email"},"markAsRead":{"type":"boolean","description":"Indicates whether email should be automatically marked as read"}}},"outboundFaxes":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"inboundTexts":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}},"missedCalls":{"type":"object","properties":{"notifyByEmail":{"type":"boolean","description":"Email notification flag"},"notifyBySms":{"type":"boolean","description":"SMS notification flag"},"advancedEmailAddresses":{"type":"array","description":"List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}},"advancedSmsEmailAddresses":{"type":"array","description":"List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only","items":{"type":"string"}}}}}}}}}},"x-api-group":"extension/notification-settings","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditMessagesNotificationsSettings","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/notification-settings\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/3446651004/extension/3446651004/notification-settings\",\n \"emailAddresses\": [\n \"alice.smith@example.com\",\n \"bob.johnson@example.com\"\n ],\n \"advancedMode\": true,\n \"voicemails\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": false,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"inboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"outboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"inboundTexts\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"missedCalls\": {\n \"notifyByEmail\": false,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n }\n}\n\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/3446651004/extension/3446651004/notification-settings\",\n \"emailAddresses\": [\n \"alice.smith@example.com\",\n \"bob.johnson@example.com\"\n ],\n \"advancedMode\": true,\n \"voicemails\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": false,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"inboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ],\n \"includeAttachment\": false,\n \"markAsRead\": false\n },\n \"outboundFaxes\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"inboundTexts\": {\n \"notifyByEmail\": true,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n },\n \"missedCalls\": {\n \"notifyByEmail\": false,\n \"notifyBySms\": true,\n \"advancedEmailAddresses\": [\n \"alice.smith@example.com\"\n ],\n \"advancedSmsEmailAddresses\": [\n \"8004576498@txt.att.net\"\n ]\n }\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-109","message":"Feature [VoicemailToText] is unavailable"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image":{"get":{"tags":["User Settings"],"summary":"Get User Profile Image","description":"Returns a profile image of an extension.","operationId":"readUserProfileImage","parameters":[{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User Profile Image Media Data","content":{"*/*":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}},"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/gif":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"extension/profile-image","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-service-level":3000,"x-http-examples":[{"request":"GET https://media.ringcentral.com/restapi/v1.0/account/~/extension/~/profile-image\n","response":"HTTP 200 OK\n\nETag: \"c93721648d8f4714e24560d3179d4433\"\nContent-Type: image/jpeg\nContent-Language: en-US\nContent-Length: 771\n\n\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-109","message":"Feature [Profile Image Streaming] is unavailable"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [extensionId] is not found"}]},"put":{"tags":["User Settings"],"summary":"Update User Profile Image","description":"Updates the extension profile image","operationId":"updateUserProfileImage","parameters":[{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"image":{"type":"string","format":"binary"}}}}}},"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/profile-image","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserInfo","x-feature":"EditExtensionInfo","x-docs-level":"Public","x-availability":"High","x-service-level":3000,"x-team":"PLA RnD","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/profile-image\nAuthorization: Bearer U0pDMDFQMDFQQVMwMnxBQUJFU3VOMlp2bjZFR3FqR1o5M29ONS1YaWd3c\nContent-Type: multipart/form-data; boundary=pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI\nContent-Length: 835\n\n--pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI\nContent-Disposition: form-data; name=\"image\"; filename=\"alice_smith.gif\"\nContent-Type: image/gif\nContent-Transfer-Encoding: binary\n\n\n--pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI--\n","response":"HTTP 204 No Content\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"ACT-331","message":"Profile image not valid"},{"httpCode":"400","errorCode":"ACT-334","message":"Profile image file is more than 12 megapixel"},{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [image] value is invalid."},{"httpCode":"403","errorCode":"ACT-332","message":"Profile image could not be set for an extension in unassigned status"},{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditExtensions] permission"},{"httpCode":"403","errorCode":"CMN-419","message":"In order to call this API endpoint for another extension, user needs to have [EditUserInfo] permission granted with extended scope"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"},{"httpCode":"415","errorCode":"ACT-330","message":"Unsupported image content type"}]},"post":{"tags":["User Settings"],"summary":"Upload User Profile Image","description":"Uploads the extension profile image.","operationId":"createUserProfileImage","parameters":[{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["image"],"properties":{"image":{"type":"string","format":"binary"}}}}},"required":true},"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"extension/profile-image","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditExtensions","x-user-permission":"EditUserInfo","x-feature":"EditExtensionInfo","x-docs-level":"Public","x-availability":"High","x-service-level":3000,"x-team":"PLA RnD","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/extension/~/profile-image\nContent-Type: multipart/form-data; boundary=pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI\n\n--pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI\nContent-Disposition: form-data; name=\"image\"; filename=\"alice_smith.gif\"\nContent-Type: image/gif\nContent-Transfer-Encoding: binary\n\n\n--pdxvZf8oX86wwlbOoPl0KtGHgwHZIVnI--\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}":{"get":{"tags":["User Settings"],"summary":"Get Scaled User Profile Image","description":"Returns scaled profile image of an extension.","operationId":"readScaledPofileImage","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"scaleSize","in":"path","description":"Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User Profile Image Media Data","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"extension/profile-image","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-service-level":3000,"x-team":"PLA RnD","x-request-max-body-size":"10m","x-http-examples":[{"request":"GET /restapi/v1.0/account/401865412008/extension/401865412008/profile-image/90x90\n","response":"HTTP 200 OK\nETag: \"c93721648d8f4714e24560d3179d4433\"\nContent-Type: image/jpeg\nContent-Language: en-US\nContent-Length: 771\n\n\n"}],"x-error-codes":[{"httpCode":"404","errorCode":"ACT-333","message":"Profile image is not found for scale size [92]"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing":{"get":{"tags":["User Settings"],"summary":"Get User Conferencing Settings","description":"Returns the information on the Free Conference Calling (FCC) feature for a given extension.","operationId":"readConferencingSettings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"countryId","in":"query","description":"Internal identifier of a country. If not specified, the response is returned for the brand country","schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a conferencing"},"allowJoinBeforeHost":{"type":"boolean","description":"Determines if host user allows conference participants to join before the host"},"hostCode":{"type":"string","description":"Access code for a host user"},"mode":{"type":"string","description":"Internal parameter specifying conferencing engine"},"participantCode":{"type":"string","description":"Access code for any participant"},"phoneNumber":{"type":"string","description":"Primary conference phone number for user's home country returned in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"tapToJoinUri":{"type":"string","description":"Short URL leading to the service web page Tap to Join for audio conference bridge"},"phoneNumbers":{"type":"array","description":"List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic","items":{"type":"object","properties":{"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a home country of a conference phone number"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"},"hasGreeting":{"type":"boolean","description":"'True' if the greeting message is played on this number"},"location":{"type":"string","description":"Location (city, region, state) of a conference phone number"},"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"premium":{"type":"boolean","description":"Indicates if the number is 'premium' (account phone number with the `ConferencingNumber` usageType)"}}}}}}}}}},"x-api-group":"extension/conferencing","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"OrganizeConference","x-feature":"Conferencing","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/conferencing?countryId=15\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/400767215008/extension/400767215008/conferencing?countryId=15\",\n \"phoneNumber\": \"+61386720111\",\n \"hostCode\": \"4007672150081\",\n \"participantCode\": \"4007672150082\",\n \"allowJoinBeforeHost\": false,\n \"tapToJoinUri\": \"http://rcconf.net/4ec24a8\",\n \"supportUri\": \"https://rcconf.net/1L06Hd5\",\n \"mode\": \"FCC\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+61386720111\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/15\",\n \"id\": \"15\",\n \"name\": \"Australia\",\n \"isoCode\": \"AU\",\n \"callingCode\": \"61\"\n },\n \"hasGreeting\": true,\n \"default\": true\n },\n {\n \"phoneNumber\": \"+543814085011\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/11\",\n \"id\": \"11\",\n \"name\": \"Argentina\",\n \"isoCode\": \"AR\",\n \"callingCode\": \"54\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+4312650505\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/16\",\n \"id\": \"16\",\n \"name\": \"Austria\",\n \"isoCode\": \"AT\",\n \"callingCode\": \"43\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+97316568305\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/19\",\n \"id\": \"19\",\n \"name\": \"Bahrain\",\n \"isoCode\": \"BH\",\n \"callingCode\": \"973\"\n },\n \"hasGreeting\": false,\n \"default\": false\n }, ...\n ]\n} \n"}],"x-error-codes":null},"put":{"tags":["User Settings"],"summary":"Update User Conferencing Settings","description":"Updates the default conferencing number for the current extension. The number can be selected from conferencing numbers of the current extension. Updates the setting, allowing participants join the conference before host.","operationId":"updateConferencingSettings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumbers":{"type":"array","description":"Multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic","items":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"}}}},"allowJoinBeforeHost":{"type":"boolean","description":"Determines if host user allows conference participants to join before the host"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a conferencing"},"allowJoinBeforeHost":{"type":"boolean","description":"Determines if host user allows conference participants to join before the host"},"hostCode":{"type":"string","description":"Access code for a host user"},"mode":{"type":"string","description":"Internal parameter specifying conferencing engine"},"participantCode":{"type":"string","description":"Access code for any participant"},"phoneNumber":{"type":"string","description":"Primary conference phone number for user's home country returned in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"tapToJoinUri":{"type":"string","description":"Short URL leading to the service web page Tap to Join for audio conference bridge"},"phoneNumbers":{"type":"array","description":"List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic","items":{"type":"object","properties":{"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a home country of a conference phone number"},"default":{"type":"boolean","description":"'True' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed"},"hasGreeting":{"type":"boolean","description":"'True' if the greeting message is played on this number"},"location":{"type":"string","description":"Location (city, region, state) of a conference phone number"},"phoneNumber":{"type":"string","description":"Dial-in phone number to connect to a conference"},"premium":{"type":"boolean","description":"Indicates if the number is 'premium' (account phone number with the `ConferencingNumber` usageType)"}}}}}}}}}},"x-api-group":"extension/conferencing","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-user-permission":"OrganizeConference","x-feature":"Conferencing","x-app-permission":"EditExtensions","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"Update Default Conferencing Phone Number","request":"PUT /restapi/v1.0/account/~/extension/~/conferencing\n\n{\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+17605697171\",\n \"default\": true\n }\n ]\n}\n","response":"{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/411020634004/extension/411020634004/conferencing\",\n \"phoneNumber\": \"+16055623180\",\n \"hostCode\": \"4110206340041\",\n \"participantCode\": \"4110206340042\",\n \"allowJoinBeforeHost\": false,\n \"tapToJoinUri\": \"http://rcconf.net/4915472\",\n \"supportUri\": \"https://rcconf.net/1L06Hd5\",\n \"mode\": \"FCC\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+16055623180\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"hasGreeting\": true,\n \"default\": true\n },\n {\n \"phoneNumber\": \"+543814085011\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.comrestapi/v1.0/dictionary/country/11\",\n \"id\": \"11\",\n \"name\": \"Argentina\",\n \"isoCode\": \"AR\",\n \"callingCode\": \"54\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+61386720111\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/15\",\n \"id\": \"15\",\n \"name\": \"Australia\",\n \"isoCode\": \"AU\",\n \"callingCode\": \"61\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+4312650505\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/16\",\n \"id\": \"16\",\n \"name\": \"Austria\",\n \"isoCode\": \"AT\",\n \"callingCode\": \"43\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+97316568305\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/19\",\n \"id\": \"19\",\n \"name\": \"Bahrain\",\n \"isoCode\": \"BH\",\n \"callingCode\": \"973\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+3232941165\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/23\",\n \"id\": \"23\",\n \"name\": \"Belgium\",\n \"isoCode\": \"BE\",\n \"callingCode\": \"32\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+552123914719\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/31\",\n \"id\": \"31\",\n \"name\": \"Brazil\",\n \"isoCode\": \"BR\",\n \"callingCode\": \"55\"\n },\n \"hasGreeting\": false,\n \"default\": false\n }, ...\n ]\n}\n"},{"title":"Update Allow Join Before Host Setting","request":"PUT /restapi/v1.0/account/~/extension/~/conferencing\n\n{\n \"allowJoinBeforeHost\" : true\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/174443004/extension/174443004/conferencing\",\n \"phoneNumber\": \"+16055623180\",\n \"hostCode\": \"1744430041\",\n \"participantCode\": \"1744430042\",\n \"allowJoinBeforeHost\": true,\n \"tapToJoinUri\": \"http://rcconf.net/4915472\",\n \"supportUri\": \"https://rcconf.net/1L06Hd5\",\n \"mode\": \"FCC\",\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"+16055623180\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"hasGreeting\": true,\n \"default\": true\n },\n {\n \"phoneNumber\": \"+543814085011\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/11\",\n \"id\": \"11\",\n \"name\": \"Argentina\",\n \"isoCode\": \"AR\",\n \"callingCode\": \"54\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+61386720111\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/15\",\n \"id\": \"15\",\n \"name\": \"Australia\",\n \"isoCode\": \"AU\",\n \"callingCode\": \"61\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+4312650505\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/16\",\n \"id\": \"16\",\n \"name\": \"Austria\",\n \"isoCode\": \"AT\",\n \"callingCode\": \"43\"\n },\n \"hasGreeting\": false,\n \"default\": false\n },\n {\n \"phoneNumber\": \"+97316568305\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/19\",\n \"id\": \"19\",\n \"name\": \"Bahrain\",\n \"isoCode\": \"BH\",\n \"callingCode\": \"973\"\n },\n \"hasGreeting\": false,\n \"default\": false\n }, ...\n ]\n}\n"}],"x-error-codes":[{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]}},"/restapi/v1.0/account/{accountId}":{"get":{"tags":["Company"],"summary":"Get Account Info","description":"Returns basic information about a particular RingCentral customer account.","operationId":"readAccountInfo","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an account"},"uri":{"type":"string","description":"Canonical URI of an account"},"bsid":{"type":"string","description":"Internal identifier of an account in the billing system"},"mainNumber":{"type":"string","description":"Main phone number of the current account"},"operator":{"type":"object","properties":{"uri":{"type":"string","description":"Link to an operator extension resource"},"id":{"type":"integer","description":"Internal identifier of an operator extension"},"extensionNumber":{"type":"string","description":"Number of an operator extension"}},"description":"Operator's extension information. This extension will receive all calls and messages intended for the operator."},"partnerId":{"type":"string","description":"Additional account identifier, created by partner application and applied on client side"},"serviceInfo":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a service info resource"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"}},"description":"Account service information, including brand, service plan and billing plan"},"setupWizardState":{"type":"string","description":"Specifies account configuration wizard state (web service setup)","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"signupInfo":{"type":"object","properties":{"tosAccepted":{"type":"boolean","default":false},"signupState":{"type":"array","items":{"type":"string","enum":["AccountCreated","BillingEntered","CreditCardApproved","AccountConfirmed","PhoneVerificationRequired","PhoneVerificationPassed"]}},"verificationReason":{"type":"string","enum":["CC_Failed","Phone_Suspicious","CC_Phone_Not_Match","AVS_Not_Available","MaxMind","CC_Blacklisted","Email_Blacklisted","Phone_Blacklisted","Cookie_Blacklisted","Device_Blacklisted","IP_Blacklisted","Agent_Instance_Blacklisted","Charge_Limit","Other_Country","Unknown"]},"marketingAccepted":{"type":"boolean","description":"Updates 'Send Marketing Information' flag on web interface"}},"description":"Account sign up data"},"status":{"type":"string","description":"Status of the current account","enum":["Initial","Confirmed","Unconfirmed","Disabled"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["SuspendedVoluntarily","SuspendedInvoluntarily","UserResumed"]},"till":{"type":"string","description":"Date until which the account will get deleted. The default value is 30 days since current date"}},"description":"Status information (reason, comment, lifetime). Returned for 'Disabled' status only"},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]},"currency":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a currency"},"code":{"type":"string","description":"Official code of a currency"},"name":{"type":"string","description":"Official name of a currency"},"symbol":{"type":"string","description":"Graphic symbol of a currency"},"minorSymbol":{"type":"string","description":"Minor graphic symbol of a currency"}},"description":"Currency information"}},"description":"Account level region data (web service Auto-Receptionist settings)"},"federated":{"type":"boolean","description":"Specifies whether an account is included into any federation of accounts or not"},"outboundCallPrefix":{"type":"integer","description":"If outbound call prefix is not specified, or set to null (0), then the parameter is not returned; the supported value range is 2-9"},"cfid":{"type":"string","description":"Customer facing identifier. Returned for accounts with the turned off PBX features. Equals to main company number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (without '+' sign)format "},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"}}}}}}},"x-api-group":"account","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12133895004\",\n \"id\": 12133895004,\n \"serviceInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12133895004/service-info\",\n \"brand\": {\n \"id\": \"1210\",\n \"name\": \"RingCentral\",\n \"homeCountry\": {\n \"id\": \"1\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n }\n },\n \"contractedCountry\": {\n \"id\": \"224\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/224\"\n },\n \"servicePlan\": {\n \"id\": \"1216\",\n \"name\": \"Professional\",\n \"edition\": \"Unknown\"\n },\n \"billingPlan\": {\n \"id\": \"159\",\n \"name\": \"Monthly\",\n \"durationUnit\": \"Month\",\n \"duration\": 1,\n \"type\": \"Regular\",\n \"includedPhoneLines\": 100\n }\n },\n \"operator\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/12133895004/extension/12133895004\",\n \"id\": 12133895004,\n \"extensionNumber\": \"101\"\n },\n \"mainNumber\": \"+18772003451\",\n \"status\": \"Confirmed\",\n \"signupInfo\": {\n \"tosAccepted\": true,\n \"signupState\": [\n \"BillingEntered\",\n \"AccountCreated\",\n \"AccountConfirmed\",\n \"CreditCardApproved\"\n ],\n \"verificationReason\": \"Unknown\"\n },\n \"setupWizardState\": \"Completed\",\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/58\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\" \n },\n \"currency\": {\n \"id\": 1,\n \"code\": \"USD\",\n \"name\": \"United States Dollars\",\n \"symbol\": \"$\",\n \"minorSymbol\": \"¢\"\n }\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"12h\"\n },\n \"federated\": false,\n \"cfid\": \"18002010310\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]}},"/restapi/v1.0/account/{accountId}/business-address":{"get":{"tags":["Company"],"summary":"Get Account Business Address","description":"Returns business address of a company.","operationId":"readAccountBusinessAddress","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"company":{"type":"string"},"email":{"type":"string"},"mainSiteName":{"type":"string","description":"Custom site name"}}}}}}},"x-api-group":"account/business-address","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/business-address\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1215058004/business-address\",\n \"businessAddress\" : {\n \"street\" : \"13 Elm Street\",\n \"city\" : \"Foster City\",\n \"state\" : \"CA\",\n \"zip\" : \"94404\",\n \"country\" : \"United States\"\n },\n \"company\" : \"Example, Inc.\",\n \"email\" : \"example@example.com\",\n \"mainSiteName\" : \"Main Site\"\n} \n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]},"put":{"tags":["Company"],"summary":"Update Company Business Address","description":"Updates the business address of a company that account is linked to. Batch request is supported.","operationId":"updateAccountBusinessAddress","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"string","description":"Company business name"},"email":{"type":"string","description":"Company business email address"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Name of a country"},"state":{"type":"string","description":"Name of a state/province"},"city":{"type":"string","description":"Name of a city"},"street":{"type":"string","description":"Street address"},"zip":{"type":"string","description":"Zip code"}},"description":"Company business address"},"mainSiteName":{"type":"string","description":"Custom site name"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","format":"uri"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"company":{"type":"string"},"email":{"type":"string"},"mainSiteName":{"type":"string","description":"Custom site name"}}}}}}},"x-api-group":"account/business-address","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyInfo","x-feature":"EditCompanyInfo","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/business-address\n\n{\n \"company\": \"Example, Inc.\",\n \"email\": \"example@example.com\",\n \"mainSiteName\" : \"Main Site\",\n \"businessAddress\": {\n \"country\": \"United States\",\n \"state\": \"CA\",\n \"city\": \"Belmont\",\n \"street\": \"20 Davis Drive\",\n \"zip\": \"94002\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1215058004/business-address\",\n \"businessAddress\" : {\n \"street\" : \"13 Elm Street\",\n \"city\" : \"Foster City\",\n \"state\" : \"CA\",\n \"zip\" : \"94404\",\n \"country\" : \"United States\"\n },\n \"company\" : \"Example, Inc.\",\n \"email\" : \"example@example.com\",\n \"mainSiteName\" : \"Main Site\"\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditAccounts] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]}},"/restapi/v1.0/account/{accountId}/service-info":{"get":{"tags":["Company"],"summary":"Get Account Service Info","description":"Returns the information about service plan, available features and limitations for a particular RingCentral customer account.","operationId":"readAccountServiceInfo","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the account Service Info resource"},"servicePlanName":{"type":"string","description":"Account Service Plan name"},"brand":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a brand"},"name":{"type":"string","description":"Brand name, for example RingCentral UK , ClearFax "},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"}},"description":"Information on account brand"},"contractedCountry":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of a contracted country"},"uri":{"type":"string","description":"Canonical URI of a contracted country"}},"description":"Information on the contracted country of account"},"servicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a service plan"},"name":{"type":"string","description":"Name of a service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account service plan"},"targetServicePlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a target service plan"},"name":{"type":"string","description":"Name of a target service plan"},"edition":{"type":"string","description":"Edition of a service plan"},"freemiumProductType":{"type":"string","enum":["Freyja","Phoenix"]}},"description":"Information on account target service plan"},"billingPlan":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a billing plan"},"name":{"type":"string","description":"Billing plan name"},"durationUnit":{"type":"string","description":"Duration period","enum":["Day","Month","Year"]},"duration":{"type":"integer","description":"Number of duration units"},"type":{"type":"string","description":"Billing plan type","enum":["Initial","Regular","Suspended","Trial","TrialNoCC","Free"]},"includedPhoneLines":{"type":"integer","description":"Included digital lines count"}},"description":"Information on account billing plan"},"serviceFeatures":{"type":"array","description":"Service features information, see Service Feature List","items":{"type":"object","properties":{"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"enabled":{"type":"boolean","description":"Feature status, shows feature availability for the extension"}}}},"limits":{"type":"object","properties":{"freeSoftPhoneLinesPerExtension":{"type":"integer","description":"Max number of free softphone phone lines per user extension"},"meetingSize":{"type":"integer","description":"Max number of participants in RingCentral meeting hosted by this account's user"},"cloudRecordingStorage":{"type":"integer","description":"Meetings recording cloud storage limitaion in Gb"},"maxMonitoredExtensionsPerUser":{"type":"integer","description":"Max number of extensions which can be included in the list of users monitored for Presence"},"maxExtensionNumberLength":{"type":"integer","description":"Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type"},"siteCodeLength":{"type":"integer","description":"Length of a site code"},"shortExtensionNumberLength":{"type":"integer","description":"Length of a short extension number"}},"description":"Limits which are effective for the account"},"package":{"type":"object","properties":{"version":{"type":"string","description":"Billing package version"},"id":{"type":"string","description":"Billing package identifier"}}}}}}}}},"x-beta-api":true,"x-api-group":"account/service-info","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadServicePlanInfo","x-feature":"ReadServicePlan","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/service-info\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402682017008/service-info\",\n \"servicePlanName\": \"RingCentral Office Ultimate\",\n \"brand\": {\n \"id\": \"1210\",\n \"name\": \"RingCentral\",\n \"homeCountry\": {\n \"id\": \"1\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n }\n },\n \"contractedCountry\": {\n \"id\": \"224\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/224\"\n },\n \"servicePlan\": {\n \"id\": \"4485\",\n \"name\": \"Office\",\n \"edition\": \"Enterprise\"\n },\n \"billingPlan\": {\n \"id\": \"3029\",\n \"name\": \"Monthly\",\n \"durationUnit\": \"Month\",\n \"duration\": 1,\n \"type\": \"Regular\",\n \"includedPhoneLines\": 1\n },\n \"serviceFeatures\": [\n {\n \"featureName\": \"MMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"AutomaticCallRecordingMute\",\n \"enabled\": false\n },\n {\n \"featureName\": \"SMS\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Intercom\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SoftPhoneUpdate\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Presence\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SMSReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VideoConferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Calendar\",\n \"enabled\": true\n },\n {\n \"featureName\": \"DND\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Conferencing\",\n \"enabled\": true\n },\n {\n \"featureName\": \"OnDemandCallRecording\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VoipCalling\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Reports\",\n \"enabled\": true\n },\n {\n \"featureName\": \"AccountFederation\",\n \"enabled\": false\n },\n {\n \"featureName\": \"EmergencyCalling\",\n \"enabled\": false\n },\n {\n \"featureName\": \"PasswordAuth\",\n \"enabled\": true\n },\n {\n \"featureName\": \"LinkedSoftphoneLines\",\n \"enabled\": false\n },\n {\n \"featureName\": \"CallerIdControl\",\n \"enabled\": false\n },\n {\n \"featureName\": \"InternationalCalling\",\n \"enabled\": false\n },\n {\n \"featureName\": \"RCTeams\",\n \"enabled\": true\n },\n {\n \"featureName\": \"BlockedMessageForwarding\",\n \"enabled\": false\n },\n {\n \"featureName\": \"AutomaticOutboundCallRecording\",\n \"enabled\": true\n },\n {\n \"featureName\": \"FaxReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Paging\",\n \"enabled\": false\n },\n {\n \"featureName\": \"UserManagement\",\n \"enabled\": false\n },\n {\n \"featureName\": \"SingleExtensionUI\",\n \"enabled\": false\n },\n {\n \"featureName\": \"FreeSoftPhoneLines\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallQualitySurvey\",\n \"enabled\": false\n },\n {\n \"featureName\": \"CallPark\",\n \"enabled\": true\n },\n {\n \"featureName\": \"AutomaticInboundCallRecording\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Pager\",\n \"enabled\": true\n },\n {\n \"featureName\": \"VoicemailToText\",\n \"enabled\": true\n },\n {\n \"featureName\": \"HDVoice\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Voicemail\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallForwarding\",\n \"enabled\": true\n },\n {\n \"featureName\": \"HipaaCompliance\",\n \"enabled\": false\n },\n {\n \"featureName\": \"InternationalSMS\",\n \"enabled\": false,\n \"reason\": \"AccountLimitation\"\n },\n {\n \"featureName\": \"DeveloperPortal\",\n \"enabled\": true\n },\n {\n \"featureName\": \"Fax\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PagerReceiving\",\n \"enabled\": true\n },\n {\n \"featureName\": \"SalesForce\",\n \"enabled\": true\n },\n {\n \"featureName\": \"RingOut\",\n \"enabled\": true\n },\n {\n \"featureName\": \"EncryptionAtRest\",\n \"enabled\": false\n },\n {\n \"featureName\": \"WebPhone\",\n \"enabled\": false\n },\n {\n \"featureName\": \"CallSupervision\",\n \"enabled\": true\n },\n {\n \"featureName\": \"CallParkLocations\",\n \"enabled\": true\n },\n {\n \"featureName\": \"PromoMessage\",\n \"enabled\": true\n },\n {\n \"featureName\": \"ExternalDirectoryIntegration\",\n \"enabled\": false\n },\n {\n \"featureName\": \"CallSwitch\",\n \"enabled\": false\n },\n {\n \"featureName\": \"SiteCodes\",\n \"enabled\": false\n }\n ],\n \"limits\": {\n \"freeSoftPhoneLinesPerExtension\": 1,\n \"meetingSize\": 50,\n \"maxMonitoredExtensionsPerUser\": 100,\n \"maxExtensionNumberLength\": 5,\n \"siteCodeLength\": 2,\n \"shortExtensionNumberLength\": 3\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/dictionary/language":{"get":{"tags":["Regional Settings"],"summary":"Get Language List","description":"Returns the information about supported languages.","operationId":"listLanguages","responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of the language list resource"},"records":{"type":"array","description":"Language data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/language","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/language\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1028\",\n \"id\": \"1028\",\n \"name\": \"Chinese (Taiwan)\",\n \"isoCode\": \"zh\",\n \"localeCode\": \"zh-TW\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1031\",\n \"id\": \"1031\",\n \"name\": \"German (Standard)\",\n \"isoCode\": \"de\",\n \"localeCode\": \"de-DE\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1033\",\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"isoCode\": \"en\",\n \"localeCode\": \"en-US\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1036\",\n \"id\": \"1036\",\n \"name\": \"French (Standard)\",\n \"isoCode\": \"fr\",\n \"localeCode\": \"fr-FR\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1040\",\n \"id\": \"1040\",\n \"name\": \"Italian (Standard)\",\n \"isoCode\": \"it\",\n \"localeCode\": \"it-IT\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1041\",\n \"id\": \"1041\",\n \"name\": \"Japanese\",\n \"isoCode\": \"ja\",\n \"localeCode\": \"ja-JP\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1046\",\n \"id\": \"1046\",\n \"name\": \"Portuguese (Brazil)\",\n \"isoCode\": \"pt\",\n \"localeCode\": \"pt-BR\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/2052\",\n \"id\": \"2052\",\n \"name\": \"Chinese (PRC)\",\n \"isoCode\": \"zh\",\n \"localeCode\": \"zh-CN\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/2057\",\n \"id\": \"2057\",\n \"name\": \"English (United Kingdom)\",\n \"isoCode\": \"en\",\n \"localeCode\": \"en-GB\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/22538\",\n \"id\": \"22538\",\n \"name\": \"Spanish (Latin America)\",\n \"isoCode\": \"es\",\n \"localeCode\": \"es-419\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/3076\",\n \"id\": \"3076\",\n \"name\": \"Chinese (Hong Kong SAR, PRC)\",\n \"isoCode\": \"zh\",\n \"localeCode\": \"zh-HK\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/3082\",\n \"id\": \"3082\",\n \"name\": \"Spanish (Spain, Modern Sort)\",\n \"isoCode\": \"es\",\n \"localeCode\": \"es-ES\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/3084\",\n \"id\": \"3084\",\n \"name\": \"French (Canadian)\",\n \"isoCode\": \"fr\",\n \"localeCode\": \"fr-CA\",\n \"ui\": true,\n \"greeting\": true,\n \"formattingLocale\": true\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 13,\n \"pageStart\": 0,\n \"pageEnd\": 12\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"400","errorCode":"OAU-236","message":"Extension is disabled or frozen"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/dictionary/language/{languageId}":{"get":{"tags":["Regional Settings"],"summary":"Get Language","description":"Returns language by ID.","operationId":"readLanguage","parameters":[{"name":"languageId","in":"path","description":"Internal identifier of a language","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"}}}}},"x-api-group":"dictionary/language","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/language/1033\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/language/1033\",\n \"id\" : \"1033\",\n \"name\" : \"English (United States)\",\n \"isoCode\" : \"en\",\n \"localeCode\" : \"en-US\",\n \"ui\" : true,\n \"greeting\" : true,\n \"formattingLocale\" : true\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/dictionary/country":{"get":{"tags":["Regional Settings"],"summary":"Get Country List","description":"Returns all the countries available for calling.","operationId":"listCountries","parameters":[{"name":"loginAllowed","in":"query","description":"Specifies whether login with the phone numbers of this country is enabled or not","schema":{"type":"boolean"}},{"name":"signupAllowed","in":"query","description":"Indicates whether signup/billing is allowed for a country. If not specified all countries are returned (according to other filters specified if any)","schema":{"type":"boolean"}},{"name":"numberSelling","in":"query","description":"Specifies if RingCentral sells phone numbers of this country","schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"freeSoftphoneLine","in":"query","description":"Specifies if free phone line for softphone is available for a country or not","schema":{"type":"boolean"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of countries supported"},"records":{"type":"array","description":"List of countries with the country data","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"},"numberSelling":{"type":"boolean","description":"Determines whether phone numbers are available for a country"},"loginAllowed":{"type":"boolean","description":"Specifies whether login with the phone numbers of this country is enabled or not"},"signupAllowed":{"type":"boolean","description":"Indicates whether signup/billing is allowed for a country"},"freeSoftphoneLine":{"type":"boolean","description":"Specifies if free phone line for softphone is available for a country or not"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/country","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"The header 'If-None-Match' is not specified","request":"GET /restapi/v1.0/dictionary/country?page=1&perPage=4&numberSelling=true&freeSoftphoneLine=true&loginAllowed=true&signupAllowed=true\n","response":"HTTP 200 OK\nETag: \"1059645308\"\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country?numberSelling=true&loginAllowed=true&freeSoftphoneLine=true&signupAllowed=true&page=1&perPage=4\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/39\",\n \"id\": \"39\",\n \"name\": \"Canada\",\n \"isoCode\": \"CA\",\n \"callingCode\": \"1\",\n \"emergencyCalling\": false,\n \"numberSelling\": true,\n \"loginAllowed\": true,\n \"freeSoftphoneLine\": true,\n \"signupAllowed\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/224\",\n \"id\": \"224\",\n \"name\": \"United Kingdom\",\n \"isoCode\": \"GB\",\n \"callingCode\": \"44\",\n \"emergencyCalling\": true,\n \"numberSelling\": true,\n \"loginAllowed\": true,\n \"freeSoftphoneLine\": true,\n \"signupAllowed\": true\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\",\n \"emergencyCalling\": false,\n \"numberSelling\": true,\n \"loginAllowed\": true,\n \"freeSoftphoneLine\": true,\n \"signupAllowed\": true\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 4,\n \"totalElements\": 3,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country?numberSelling=true&loginAllowed=true&freeSoftphoneLine=true&signupAllowed=true&page=1&perPage=4\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country?numberSelling=true&loginAllowed=true&freeSoftphoneLine=true&signupAllowed=true&page=1&perPage=4\"\n }\n }\n}\n"},{"title":"The header 'If-None-Match' is specified and the Country list has not been changed","request":"GET /restapi/v1.0/dictionary/country\nIf-None-Match: \"1059645308\"\n","response":"HTTP 304 Not Modified\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"OAU-127","message":"Invalid application"},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"},{"httpCode":"429","errorCode":"CMN-304","message":"Duplicate concurrent request. Try again later"}]}},"/restapi/v1.0/dictionary/country/{countryId}":{"get":{"tags":["Regional Settings"],"summary":"Get Country","description":"Returns the information on a specific country.","operationId":"readCountry","parameters":[{"name":"countryId","in":"path","description":"Internal identifier of a country","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a country"},"numberSelling":{"type":"boolean","description":"Determines whether phone numbers are available for a country"},"loginAllowed":{"type":"boolean","description":"Specifies whether login with the phone numbers of this country is enabled or not"},"signupAllowed":{"type":"boolean","description":"Indicates whether signup/billing is allowed for a country"},"freeSoftphoneLine":{"type":"boolean","description":"Specifies if free phone line for softphone is available for a country or not"}}}}}}},"x-api-group":"dictionary/country","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/country/75\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/75\",\n \"id\" : \"75\",\n \"name\" : \"France\",\n \"isoCode\" : \"FR\",\n \"callingCode\" : \"33\",\n \"emergencyCalling\" : false,\n \"numberSelling\" : true,\n \"loginAllowed\" : true,\n \"signupAllowed\" : true,\n \"freeSoftphoneLine\" : true\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/dictionary/location":{"get":{"tags":["Regional Settings"],"summary":"Get Location List","description":"Returns all available locations for a certain state.","operationId":"listLocations","parameters":[{"name":"orderBy","in":"query","description":"Sorts results by the property specified","schema":{"type":"string","default":"City","enum":["Npa","City"]}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"stateId","in":"query","description":"Internal identifier of a state","schema":{"type":"string"}},{"name":"withNxx","in":"query","description":"Specifies if nxx codes are returned","schema":{"type":"boolean"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the location list resource"},"records":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a location"},"areaCode":{"type":"string","description":"Area code of the location"},"city":{"type":"string","description":"Official name of the city, belonging to the certain state"},"npa":{"type":"string","description":"Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"nxx":{"type":"string","description":"Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan"},"state":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Link to a state resource"}},"description":"Information on the state this location belongs to"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/location","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/location?page=60&perPage=5&stateId=16\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/location?stateId=16&withNxx=true&orderBy=city&page=60&perPage=5\",\n \"records\" : [ {\n \"city\" : \"Beverly Hills\",\n \"areaCode\" : \"310\",\n \"npa\" : \"310\",\n \"nxx\" : \"284\",\n \"state\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\"\n }\n }, {\n \"city\" : \"Beverly Hills\",\n \"areaCode\" : \"310\",\n \"npa\" : \"310\",\n \"nxx\" : \"288\",\n \"state\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\"\n }\n }, {\n \"city\" : \"Beverly Hills\",\n \"areaCode\" : \"310\",\n \"npa\" : \"310\",\n \"nxx\" : \"299\",\n \"state\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\"\n }\n }, {\n \"city\" : \"Beverly Hills\",\n \"areaCode\" : \"310\",\n \"npa\" : \"310\",\n \"nxx\" : \"360\",\n \"state\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\"\n }\n }, {\n \"city\" : \"Beverly Hills\",\n \"areaCode\" : \"310\",\n \"npa\" : \"310\",\n \"nxx\" : \"388\",\n \"state\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\"\n }\n } ],\n \"paging\" : {\n \"page\" : 60,\n \"totalPages\" : 1068,\n \"perPage\" : 5,\n \"totalElements\" : 5339,\n \"pageStart\" : 295,\n \"pageEnd\" : 299\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/location?stateId=16&withNxx=true&orderBy=city&page=61&perPage=5\"\n },\n \"previousPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/location?stateId=16&withNxx=true&orderBy=city&page=59&perPage=5\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/location?stateId=16&withNxx=true&orderBy=city&page=1&perPage=5\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/location?stateId=16&withNxx=true&orderBy=city&page=1068&perPage=5\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/dictionary/state":{"get":{"tags":["Regional Settings"],"summary":"Get States List","description":"Returns all the states of a certain country","operationId":"listStates","parameters":[{"name":"allCountries","in":"query","description":"If set to 'True' then states for all countries are returned and `countryId` is ignored, even if specified. If the value is empty then the parameter is ignored","schema":{"type":"boolean"}},{"name":"countryId","in":"query","description":"Internal identifier of a country","schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"withPhoneNumbers","in":"query","description":"If 'True', the list of states with phone numbers available for buying is returned","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the states list resource"},"records":{"type":"array","description":"List of states","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"}},"description":"Information on a country the state belongs to"},"isoCode":{"type":"string","description":"Short code for a state (2-letter usually)"},"name":{"type":"string","description":"Official name of a state"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/state","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/state?countryId=1&page=1&perPage=5\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state?countryId=1&withPhoneNumbers=false&page=1&perPage=5\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/12\",\n \"id\" : \"12\",\n \"name\" : \"Alabama\",\n \"isoCode\" : \"AL\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/13\",\n \"id\" : \"13\",\n \"name\" : \"Alaska\",\n \"isoCode\" : \"AK\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/14\",\n \"id\" : \"14\",\n \"name\" : \"Arizona\",\n \"isoCode\" : \"AZ\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/15\",\n \"id\" : \"15\",\n \"name\" : \"Arkansas\",\n \"isoCode\" : \"AR\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/401\",\n \"id\" : \"401\",\n \"name\" : \"American Samoa\",\n \"isoCode\" : \"AM\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 11,\n \"perPage\" : 5,\n \"totalElements\" : 55,\n \"pageStart\" : 0,\n \"pageEnd\" : 4\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state?countryId=1&withPhoneNumbers=false&page=2&perPage=5\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state?countryId=1&withPhoneNumbers=false&page=1&perPage=5\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state?countryId=1&withPhoneNumbers=false&page=11&perPage=5\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/dictionary/state/{stateId}":{"get":{"tags":["Regional Settings"],"summary":"Get State","description":"Returns the information on a specific state.","operationId":"readState","parameters":[{"name":"stateId","in":"path","description":"Internal identifier of a state","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a state"},"uri":{"type":"string","description":"Canonical URI of a state"}},"description":"Information on a country the state belongs to"},"isoCode":{"type":"string","description":"Short code for a state (2-letter usually)"},"name":{"type":"string","description":"Official name of a state"}}}}}}},"x-api-group":"dictionary/state","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/state/16\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/state/16\",\n \"id\" : \"16\",\n \"name\" : \"California\",\n \"isoCode\" : \"CA\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/dictionary/timezone":{"get":{"tags":["Regional Settings"],"summary":"Get Timezone List","description":"Returns all available timezones.","operationId":"listTimezones","parameters":[{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"string","default":"100"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the timezone list resource"},"records":{"type":"array","description":"List of timezones","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Description of a timezone"},"bias":{"type":"string"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"dictionary/timezone","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/timezone?page=11&perPage=5\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone?page=11&perPage=5\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/51\",\n \"id\": \"51\",\n \"name\": \"US/Eastern\",\n \"description\": \"Eastern Time (US & Canada)\",\n \"bias\": \"-300\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/52\",\n \"id\": \"52\",\n \"name\": \"America/Indianapolis\",\n \"description\": \"Indiana (East)\",\n \"bias\": \"-300\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/53\",\n \"id\": \"53\",\n \"name\": \"US/Central\",\n \"description\": \"Central Time (US & Canada)\",\n \"bias\": \"-360\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/54\",\n \"id\": \"54\",\n \"name\": \"America/Mexico_City\",\n \"description\": \"Guadalajara, Mexico City, Monterrey\",\n \"bias\": \"-360\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/55\",\n \"id\": \"55\",\n \"name\": \"Canada/Saskatchewan\",\n \"description\": \"Saskatchewan\",\n \"bias\": \"-360\"\n }\n ],\n \"paging\": {\n \"page\": 11,\n \"totalPages\": 19,\n \"perPage\": 5,\n \"totalElements\": 91,\n \"pageStart\": 50,\n \"pageEnd\": 54\n },\n \"navigation\": {\n \"nextPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone?page=12&perPage=5\"\n },\n \"previousPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone?page=10&perPage=5\"\n },\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone?page=1&perPage=5\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone?page=19&perPage=5\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/dictionary/timezone/{timezoneId}":{"get":{"tags":["Regional Settings"],"summary":"Get Timezone","description":"Returns the information on a certain timezone.","operationId":"readTimezone","parameters":[{"name":"timezoneId","in":"path","description":"Internal identifier of a timezone","required":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"string","default":"100"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Description of a timezone"},"bias":{"type":"string"}}}}}}},"x-api-group":"dictionary/timezone","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/dictionary/timezone/58\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/58\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/account/{accountId}/phone-number":{"get":{"tags":["Phone Numbers"],"summary":"Get Company Phone Number List","description":"Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned.","operationId":"listAccountPhoneNumbers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"usageType","in":"query","description":"Usage type of a phone number","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","MeetingsNumber","BusinessMobileNumber","ExternalMobileNumber"]}}},{"name":"status","in":"query","description":"Status of a phone number. Multiple values are supported","schema":{"type":"string","enum":["Normal","Pending","PortedIn","Temporary"]}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of account phone numbers"},"records":{"type":"array","description":"List of account phone numbers","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a company phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","MeetingsNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"temporaryNumber":{"type":"object","properties":{"id":{"type":"string","description":"Temporary phone number identifier"},"phoneNumber":{"type":"string","description":"Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}},"description":"Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"vanityPattern":{"type":"string","description":"Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/phone-number","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyPhoneNumbers","x-feature":"ReadAccountPhoneNumbers","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/1717093004/phone-number?perPage=4\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number?page=1&perPage=4\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162821004\",\n \"id\" : 1162821004,\n \"phoneNumber\" : \"+18002024080\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceOnly\",\n \"usageType\" : \"DirectNumber\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/extension/1717095004\",\n \"id\" : 1717095004,\n \"extensionNumber\" : \"102\"\n },\n \"status\" : \"Normal\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162822004\",\n \"id\" : 1162822004,\n \"phoneNumber\" : \"+18332023665\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceOnly\",\n \"usageType\" : \"DirectNumber\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/extension/1717096004\",\n \"id\" : 1717096004,\n \"extensionNumber\" : \"103\"\n },\n \"status\" : \"Normal\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162820004\",\n \"id\" : 1162820004,\n \"phoneNumber\" : \"+18552023884\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"FaxOnly\",\n \"usageType\" : \"CompanyFaxNumber\",\n \"status\" : \"Normal\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162818004\",\n \"id\" : 1162818004,\n \"phoneNumber\" : \"+18662023455\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"MainCompanyNumber\",\n \"status\" : \"Normal\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 2,\n \"perPage\" : 4,\n \"totalElements\" : 5,\n \"pageStart\" : 0,\n \"pageEnd\" : 3\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number?page=2&perPage=4\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number?page=1&perPage=4\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number?page=2&perPage=4\"\n }\n } \n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}":{"get":{"tags":["Phone Numbers"],"summary":"Get Phone Number","description":"Returns the phone number(s) belonging to a certain account or extension by phoneNumberId(s). Batch request is supported.","operationId":"readAccountPhoneNumber","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"phoneNumberId","in":"path","description":"Internal identifier of a phone number","required":true,"schema":{"type":"integer"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a company phone number resource"},"id":{"type":"integer","description":"Internal identifier of a phone number"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local","BusinessMobileNumberProvider","ExternalNumberProvider"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of a phone number. Usage type of a phone number. Numbers of 'NumberPool' type wont't be returned for phone number list requests","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber","ConferencingNumber","MeetingsNumber","NumberPool","BusinessMobileNumber","ExternalMobileNumber"]},"temporaryNumber":{"type":"object","properties":{"id":{"type":"string","description":"Temporary phone number identifier"},"phoneNumber":{"type":"string","description":"Temporary phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"}},"description":"Temporary phone number, if any. Returned for phone numbers in `Pending` porting status only"},"contactCenterProvider":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the provider"},"name":{"type":"string","description":"Provider's name"}},"description":"CCRN (Contact Center Routing Number) provider. If not specified then the default value 'InContact/North America' is used, its ID is '1'"},"vanityPattern":{"type":"string","description":"Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters nxx plus line or numberPattern"}}}}}}},"x-api-group":"account/phone-number","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyPhoneNumbers","x-feature":"ReadAccountPhoneNumbers","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"title":"Single Phone Number","request":"GET /restapi/v1.0/account/1717093004/phone-number/1162821004\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162821004\",\n \"id\" : 1162821004,\n \"phoneNumber\" : \"+18002024080\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceOnly\",\n \"usageType\" : \"DirectNumber\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/extension/1717095004\",\n \"id\" : 1717095004,\n \"extensionNumber\" : \"102\"\n },\n \"status\" : \"Normal\"\n}\n"},{"title":"Multiple Phone Numbers","request":"GET /restapi/v1.0/account/1717093004/phone-number/1162821004%2C%201162818004%2C%201162820004%20\n","response":"HTTP 207 \n\n--Boundary_1_1014758142_1536940506949\nContent-Type: application/json\n\n{\n \"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162821004\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162818004\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162820004\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n } ]\n}\n--Boundary_1_1014758142_1536940506949\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162821004\",\n \"id\" : 1162821004,\n \"phoneNumber\" : \"+18002024080\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceOnly\",\n \"usageType\" : \"DirectNumber\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/extension/1717095004\",\n \"id\" : 1717095004,\n \"extensionNumber\" : \"102\"\n },\n \"status\" : \"Normal\"\n}\n--Boundary_1_1014758142_1536940506949\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162818004\",\n \"id\" : 1162818004,\n \"phoneNumber\" : \"+18662023455\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"MainCompanyNumber\",\n \"status\" : \"Normal\"\n}\n--Boundary_1_1014758142_1536940506949\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1717093004/phone-number/1162820004\",\n \"id\" : 1162820004,\n \"phoneNumber\" : \"+18552023884\",\n \"paymentType\" : \"TollFree\",\n \"type\" : \"FaxOnly\",\n \"usageType\" : \"CompanyFaxNumber\",\n \"status\" : \"Normal\"\n}\n--Boundary_1_1014758142_1536940506949--\n"}],"x-error-codes":[{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [phoneNumberId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension":{"get":{"tags":["Extensions"],"summary":"Get Extension List","description":"Returns the list of extensions created for a particular account. All types of extensions are included in this list.","operationId":"listExtensions","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionNumber","in":"query","description":"Number of extension to be retrieved","schema":{"type":"string"}},{"name":"email","in":"query","description":"Extension email address","schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","format":"int64","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","format":"int64","default":100}},{"name":"status","in":"query","description":"Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without `extensionNumber` attribute are returned. If not specified, then all extensions are returned.","allowEmptyValue":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Enabled","Disabled","NotActivated","Unassigned"]}}},{"name":"type","in":"query","description":"Extension type. Multiple values are supported. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","allowEmptyValue":true,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Limited","Bot","ProxyAdmin","DelegatedLinesGroup"]}}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the extension list resource"},"records":{"type":"array","description":"List of extensions with extension information","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"extensionNumber":{"type":"string","description":"Number of an extension"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","FaxUser","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","Bot","Room","Limited","Site","ProxyAdmin","DelegatedLinesGroup","GroupCallPickup"]},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"Period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-notifications":[{"type":"object","properties":{"uuid":{"type":"string","description":"Universally unique identifier of a notification"},"event":{"type":"string","description":"Event filter URI"},"timestamp":{"type":"string","description":"Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z*"},"subscriptionId":{"type":"string","description":"Internal identifier of a subscription"},"body":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"eventType":{"type":"string","description":"Type of extension info change","enum":["Create","Update","Delete"]},"ownerId":{"type":"string","description":"Internal identifier of a subscription owner extension"}},"description":"Notification payload body"}}}],"x-service-level":1000,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension?page=1&perPage=2\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401836781008/extension?page=1&perPage=2\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401836781008/extension/401864056008\",\n \"id\": 401864056008,\n \"extensionNumber\": \"102\",\n \"contact\": {\n \"firstName\": \"Bob\",\n \"lastName\": \"Johnson\",\n \"email\": \"bob.johnson@example.com\",\n \"emailAsLoginName\": true\n },\n \"name\": \"Bob Johnson\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": false\n },\n \"internationalCalling\": {\n \"enabled\": true\n }\n },\n \"profileImage\": {\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/401836781008/extension/401864056008/profile-image\"\n }\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401836781008/extension/401836781008\",\n \"id\": 401836781008,\n \"extensionNumber\": \"101\",\n \"contact\": {\n \"firstName\": \"Alice\",\n \"lastName\": \"Smith\",\n \"company\": \"Example, Inc.\",\n \"email\": \"alice.smith@example.com\",\n \"businessPhone\": \"+16025809302\",\n \"emailAsLoginName\": true\n },\n \"name\": \"Alice Smith\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": true\n },\n \"internationalCalling\": {\n \"enabled\": true\n }\n },\n \"profileImage\": {\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/401836781008/extension/401836781008/profile-image\",\n \"etag\": \"7a1decb8efda89d7c0acff42f061d99d\",\n \"contentType\": \"image/gif\",\n \"lastModified\": \"2016-02-26T09:29:45.316Z\",\n \"scales\": [\n {\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/401836781008/extension/401836781008/profile-image/90x90\"\n },\n {\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/401836781008/extension/401836781008/profile-image/195x195\"\n },\n {\n \"uri\": \"https://media.ringcentral.com/restapi/v1.0/account/401836781008/extension/401836781008/profile-image/584x584\"\n }\n ]\n }\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 2,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401836781008/extension?page=1&perPage=2\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401836781008/extension?page=1&perPage=2\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [page] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"post":{"tags":["Extensions"],"summary":"Create Extension","description":"Creates an extension.","operationId":"createExtension","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact Information"},"extensionNumber":{"type":"string","description":"Number of extension"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"password":{"type":"string","description":"Password for extension. If not specified, the password is auto-generated"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"partnerId":{"type":"string","description":"Additional extension identifier, created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup).","default":"NotStarted","enum":["NotStarted","Incomplete","Completed"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal idetifier of a site extension"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Extension user first name"},"extensionNumber":{"type":"string","description":"Extension number"},"callerIdName":{"type":"string","description":"Custom name of a caller. Max number of characters is 15 (only alphabetical symbols, numbers and commas are supported)"},"email":{"type":"string","description":"Exetnsion user email"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"operator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an operator"},"uri":{"type":"string","description":"Link to an operator resource"},"extensionNumber":{"type":"string","description":"Extension number (pin)"},"name":{"type":"string","description":"Operator extension user full name"}},"description":"Site Fax/SMS recipient (operator) reference. Multi-level IVR should be enabled"},"code":{"type":"string","description":"Site code value. Returned only if specified"}}},"status":{"type":"string","description":"Extension current state","enum":["Enabled","Disabled","NotActivated","Unassigned","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","Limited"]},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only. For unassigned extensions the value is set to 'True' by default. For assigned extensions the value is set to 'False' by default"}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":"If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case.","default":false},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}},"description":"Contact detailed information"},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"extensionNumber":{"type":"string","description":"Number of extension"},"name":{"type":"string","description":"Extension name. For user extension types the value is a combination of the specified first name and last name"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"},"permissions":{"type":"object","properties":{"admin":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"Admin permission"},"internationalCalling":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Specifies if a permission is enabled or not"}},"description":"International Calling permission"}},"description":"Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'"},"profileImage":{"required":["uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a profile image. If an image is not uploaded for an extension, only uri is returned"},"etag":{"type":"string","description":"Identifier of an image"},"lastModified":{"type":"string","description":"The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z","format":"date-time"},"contentType":{"type":"string","description":"The type of an image"},"scales":{"type":"array","description":"List of URIs to profile images in different dimensions","items":{"type":"object","properties":{"uri":{"type":"string"}}}}},"description":"Information on profile image"},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"},"isoCode":{"type":"string","description":"ISO code of a country"},"callingCode":{"type":"string","description":"Calling code of a country"}},"description":"Country information"},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a timezone"},"uri":{"type":"string","description":"Canonical URI of a timezone"},"name":{"type":"string","description":"Short name of a timezone"},"description":{"type":"string","description":"Meaningful description of the timezone"},"bias":{"type":"string"}},"description":"Extension timezone information"},"language":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a language"},"uri":{"type":"string","description":"Canonical URI of a language"},"greeting":{"type":"boolean","description":"Indicates whether a language is available as greeting language"},"formattingLocale":{"type":"boolean","description":"Indicates whether a language is available as formatting locale"},"localeCode":{"type":"string","description":"Localization code of a language"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html)"},"name":{"type":"string","description":"Official name of a language"},"ui":{"type":"boolean","description":"Indicates whether a language is available as UI language"}},"description":"User interface language data"},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a greeting language"},"localeCode":{"type":"string","description":"Localization code of a greeting language"},"name":{"type":"string","description":"Official name of a greeting language"}},"description":"Information on language used for telephony greetings"},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a formatting language"},"localeCode":{"type":"string","description":"Localization code of a formatting language"},"name":{"type":"string","description":"Official name of a formatting language"}},"description":"Formatting language preferences for numbers, dates and currencies"},"timeFormat":{"type":"string","description":"Time format setting. The default value is '12h' = ['12h', '24h']","enum":["12h","24h"]}},"description":"Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings"},"serviceFeatures":{"type":"array","description":"Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features","items":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Feature status; shows feature availability for an extension"},"featureName":{"type":"string","description":"Feature name","enum":["AccountFederation","Archiver","AutomaticCallRecordingMute","AutomaticInboundCallRecording","AutomaticOutboundCallRecording","BlockedMessageForwarding","Calendar","CallerIdControl","CallForwarding","CallPark","CallParkLocations","CallSupervision","CallSwitch","CallQualitySurvey","Conferencing","ConferencingNumber","ConfigureDelegates","DeveloperPortal","DND","DynamicConference","EmergencyAddressAutoUpdate","EmergencyCalling","EncryptionAtRest","ExternalDirectoryIntegration","Fax","FaxReceiving","FreeSoftPhoneLines","HDVoice","HipaaCompliance","Intercom","InternationalCalling","InternationalSMS","LinkedSoftphoneLines","MMS","MobileVoipEmergencyCalling","OnDemandCallRecording","Pager","PagerReceiving","Paging","PasswordAuth","PromoMessage","Reports","Presence","RCTeams","RingOut","SalesForce","SharedLines","SingleExtensionUI","SiteCodes","SMS","SMSReceiving","SoftPhoneUpdate","TelephonySessions","UserManagement","VideoConferencing","VoipCalling","VoipCallingOnMobile","Voicemail","VoicemailToText","WebPhone"]},"reason":{"type":"string","description":"Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response"}}}},"setupWizardState":{"type":"string","description":"Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted'","enum":["NotStarted","Incomplete","Completed"]},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"status":{"type":"string","description":"Extension current state. If 'Unassigned' is specified, then extensions without ‘extensionNumber’ are returned. If not specified, then all extensions are returned","enum":["Enabled","Disabled","Frozen","NotActivated","Unassigned"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","ParkLocation","Limited"]},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"}}}}}}},"x-api-group":"extension","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"AddRemoveUsers","x-feature":"EditUsers","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"title":"Create User Extension","request":"POST /restapi/v1.0/account/~/extension\n\n{\n \"contact\": {\n \"firstName\": \"Frank\",\n \"lastName\": \"Davis\",\n \"email\": \"frank.davis@example.com\"\n },\n \"type\": \"User\",\n \"regionalSettings\": {\n \"timeFormat\": \"24h\"\n }\n}\n","response":"{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402533461008/extension/402533467008\",\n \"id\": 402533467008,\n \"extensionNumber\": \"106\",\n \"contact\": {\n \"firstName\": \"Frank\",\n \"lastName\": \"Davis\",\n \"email\": \"frank.davis@example.com\",\n \"emailAsLoginName\": true,\n \"pronouncedName\": {\n \"type\": \"Default\",\n \"text\": \"Frank Davis\"\n }\n },\n \"name\": \"Frank Davis\",\n \"type\": \"User\",\n \"status\": \"NotActivated\",\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/58\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n },\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"24h\"\n },\n \"setupWizardState\": \"NotStarted\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": false\n },\n \"internationalCalling\": {\n \"enabled\": true\n }\n },\n \"profileImage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402533461008/extension/402533467008/profile-image\"\n }\n}\n"},{"title":"Create Call Queue Extension","request":"POST /restapi/v1.0/account/~/extension\n\n{\n \"extensionNumber\": \"107\",\n \"type\": \"Department\",\n \"contact\": {\n \"firstName\": \"Sales\",\n \"email\": \"sales@example.com\"\n }\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404888975008/extension/405099182008\",\n \"id\": 405099182008,\n \"extensionNumber\": \"107\",\n \"contact\": {\n \"firstName\": \"Sales\",\n \"email\": \"sales@example.com\",\n \"pronouncedName\": {\n \"type\": \"Default\",\n \"text\": \"Sales\"\n }\n },\n \"name\": \"Sales\",\n \"type\": \"Department\",\n \"status\": \"NotActivated\",\n \"regionalSettings\": {\n \"timezone\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/58\",\n \"id\": \"58\",\n \"name\": \"US/Pacific\",\n \"description\": \"Pacific Time (US & Canada)\",\n \"bias\": \"-480\"\n },\n \"homeCountry\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"language\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"greetingLanguage\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"formattingLocale\": {\n \"id\": \"1033\",\n \"name\": \"English (United States)\",\n \"localeCode\": \"en-US\"\n },\n \"timeFormat\": \"12h\"\n },\n \"setupWizardState\": \"NotStarted\",\n \"permissions\": {\n \"admin\": {\n \"enabled\": false\n },\n \"internationalCalling\": {\n \"enabled\": false\n }\n },\n \"profileImage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404888975008/extension/405099182008/profile-image\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [contact.email] value is invalid."},{"httpCode":"400","errorCode":"EXT-356","message":"[lastName] cannot be specified for non-user extension."}]}},"/restapi/v1.0/account/{accountId}/templates":{"get":{"tags":["Extensions"],"summary":"Get User Template List","description":"Returns the list of user templates for the current account.","operationId":"listUserTemplates","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","enum":["UserSettings","CallHandling"]}},{"name":"page","in":"query","schema":{"type":"string"}},{"name":"perPage","in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to user templates resource"},"records":{"type":"array","description":"List of user templates","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a template"},"id":{"type":"string","description":"Internal identifier of a template"},"type":{"type":"string","enum":["UserSettings","CallHandling"]},"name":{"type":"string","description":"Name of a template"},"creationTime":{"type":"string","description":"Time of a template creation"},"lastModifiedTime":{"type":"string","description":"Time of the last template modification"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/templates","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/403283863008/templates?type=UserSettings\n\n","response":"HTTP 200 OK\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403283863008/templates?type=UserSettings&page=1&perPage=100\",\n \"records\": [ \n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403283863008/templates/697008\",\n \"id\": \"697008\",\n \"name\": \"Template #1\",\n \"type\": \"UserSettings\",\n \"creationTime\": \"2019-04-18T19:00:34Z\",\n \"lastModifiedTime\": \"2019-04-18T19:00:34Z\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 1,\n \"pageStart\": 0,\n \"pageEnd\": 0\n },\n \"navigation\": {\n \"firstPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403283863008/templates?type=UserSettings&page=1&perPage=100\"},\n \"lastPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/403283863008/templates?type=UserSettings&page=1&perPage=100\"}\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/templates/{templateId}":{"get":{"tags":["Extensions"],"summary":"Get User Template","description":"Returns the user template by ID.","operationId":"readUserTemplate","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a template"},"id":{"type":"string","description":"Internal identifier of a template"},"type":{"type":"string","enum":["UserSettings","CallHandling"]},"name":{"type":"string","description":"Name of a template"},"creationTime":{"type":"string","description":"Time of a template creation"},"lastModifiedTime":{"type":"string","description":"Time of the last template modification"}}}}}}},"x-api-group":"account/templates","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyInfo","x-feature":"ReadCompanyInfo","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/403283863008/templates/697008\n\n``` \n### Response\n```HTTP\nHTTP 200 OK \n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403283863008/templates/697008\",\n \"id\" : \"697008\",\n \"name\" : \"Template #1\",\n \"type\" : \"UserSettings\",\n \"creationTime\" : \"2019-04-18T19:00:34Z\",\n \"lastModifiedTime\" : \"2019-04-18T19:00:34Z\"\n}\n","response":""},{"request":"GET /restapi/v1.0/account/401180509008/emergency-address-auto-update/users\n\n``` \n### Response\n```HTTP\nHTTP/1.1 200 OK\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/users?orderBy=%2BfullName&page=1&perPage=100\",\n \"records\": [\n {\n \"id\": \"401180512008\",\n \"fullName\": \"Alice Brown\",\n \"extensionNumber\": \"103\",\n \"featureEnabled\": false,\n \"type\": \"User\",\n \"site\": {\n \"id\": \"main-site\",\n \"name\": \"Main Site\"\n }\n },\n {\n \"id\": \"401180511008\",\n \"fullName\": \"Bob Johnson\",\n \"extensionNumber\": \"102\",\n \"featureEnabled\": false,\n \"type\": \"User\",\n \"site\": {\n \"id\": \"main-site\",\n \"name\": \"Main Site\"\n }\n },\n {\n \"id\": \"401180509008\",\n \"fullName\": \"Charlie Williams\",\n \"extensionNumber\": \"101\",\n \"featureEnabled\": false,\n \"type\": \"User\",\n \"site\": {\n \"id\": \"main-site\",\n \"name\": \"Main Site\"\n }\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 3,\n \"pageStart\": 0,\n \"pageEnd\": 2\n },\n \"navigation\": {\n \"firstPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/users?orderBy=%2BfullName&page=1&perPage=100\"},\n \"lastPage\": {\"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/401180509008/emergency-address-auto-update/users?orderBy=%2BfullName&page=1&perPage=100\"}\n }\n}\n","response":""},{"request":"POST /restapi/v1.0/account/401180509008/emergency-address-auto-update/users/bulk-assign\n\n {\n \"enabledUserIds\": \n [\n \"401180509008\",\n \"401180511008\"\n ],\n \"disabledUserIds\":\n [\"401180512008\"\n ]\n}\n","response":"HTTP/1.1 204 No Content\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/video-configuration":{"get":{"tags":["Video Configuration"],"summary":"Get User Video Configuration","description":"Returns information about video configuration of the current user.","operationId":"readUserVideoConfiguration","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the current session account","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"User Video Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"Video provider of the user","enum":["RCMeetings","RCVideo","None"]},"userLicenseType":{"type":"string","description":"Specifies if the user is 'paid' (has meeting license) or 'free' (w/o meeting license)","enum":["Paid","Free"]}}}}}}},"x-api-group":"account/extension/video-configuration","x-app-permission":"Meetings","x-user-permission":"Meetings","x-throttling-group":"Light","x-docs-level":"Public","x-metered-api":true,"x-metering-group":"System","x-availability":"High","x-error-codes":null},"put":{"tags":["Video Configuration"],"summary":"Update User Video Configuration","description":"Allows to update user video settings, for example video provider.","operationId":"updateUserVideoConfiguration","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the current session account","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"Video provider of the user","enum":["RCMeetings","RCVideo","None"]},"userLicenseType":{"type":"string","description":"Specifies if the user is 'paid' (has meeting license) or 'free' (w/o meeting license)","enum":["Paid","Free"]}}}}},"required":true},"responses":{"200":{"description":"Video Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"Video provider of the user","enum":["RCMeetings","RCVideo","None"]},"userLicenseType":{"type":"string","description":"Specifies if the user is 'paid' (has meeting license) or 'free' (w/o meeting license)","enum":["Paid","Free"]}}}}}}},"x-api-group":"account/extension/video-configuration","x-app-permission":"Meetings","x-feature":"Meetings, EditMeetingsProvider","x-throttling-group":"Light","x-docs-level":"Public","x-metered-api":true,"x-metering-group":"System","x-availability":"High","x-codegen-request-body-name":"body","x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [provider] value is invalid."},{"httpCode":"403","errorCode":"BIL-101","message":"Feature [EditMeetingsProvider] is not available for current service plan"},{"httpCode":"403","errorCode":"BIL-103","message":"Feature [Meetings] is not available for current account"}]}},"/restapi/v1.0/account/{accountId}/call-queues":{"get":{"tags":["Call Queues"],"summary":"Get Call Queue List","description":"Returns call queue group list.","operationId":"listCallQueues","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"memberExtensionId","in":"query","description":"Internal identifier of an extension that is a member of every group within the result","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queues resource"},"records":{"type":"array","description":"List of call queues","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Name of a call queue"},"extensionNumber":{"type":"string","description":"Extension number of a call queue"},"editableMemberStatus":{"type":"boolean","description":"Flag allow members to change their queue status"}},"description":"Call queue information"}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-queues","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-throttling-group":"Medium","x-docs-level":"Public","x-service-level":1000,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/call-queues?perPage=20\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/230919004/call-queues?page=1&perPage=20\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/26456001/extension/41004\",\n \"id\": \"41004\",\n \"extensionNumber\": \"102\",\n \"name\": \"Support\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/26456001/extension/41023\",\n \"id\": \"41023\",\n \"extensionNumber\": \"106\",\n \"name\": \"Sales\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 20,\n \"totalElements\": 2\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/230919004/call-queues?page=1&perPage=20\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/230919004/call-queues?page=1&perPage=20\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-queues/{groupId}":{"get":{"tags":["Call Queues"],"summary":"Get Call Queue","description":"Returns basic information on a call queue group extension.","operationId":"readCallQueueInfo","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Call Queue Info","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Call queue name"},"extensionNumber":{"type":"string","description":"Call queue extension number"},"status":{"type":"string","description":"Call queue status","enum":["Enabled","Disabled","NotActivated"]},"serviceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"editableMemberStatus":{"type":"boolean","description":"Allows members to change their queue status"}}}}}}},"x-api-group":"account/call-queues","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-throttling-group":"Light","x-docs-level":"Public","x-feature":"ReadExtensions","x-http-examples":[{"request":"GET /restapi/v1.0/account/401154466044/call-queues/401154469044\n\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"401154469044\",\n \"name\" : \"John Smith\",\n \"extensionNumber\" : \"103\",\n \"status\" : \"Enabled\"\n\n}\n\n"}],"x-error-codes":null},"put":{"tags":["Call Queues"],"summary":"Update Call Queue","description":"Updates information on a call queue group extension.","operationId":"updateCallQueueInfo","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"serviceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"editableMemberStatus":{"type":"boolean","description":"Allows members to change their queue status"}}}}},"required":true},"responses":{"200":{"description":"Updated Call Queue Info","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call queue"},"name":{"type":"string","description":"Call queue name"},"extensionNumber":{"type":"string","description":"Call queue extension number"},"status":{"type":"string","description":"Call queue status","enum":["Enabled","Disabled","NotActivated"]},"serviceLevelSettings":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer","description":"The period of time in seconds that is considered to be an acceptable service level"},"includeAbandonedCalls":{"type":"boolean","description":"Includes abandoned calls (when callers hang up prior to being served by an agent) into service-level calculation"},"abandonedThresholdSeconds":{"type":"integer","description":"Abandoned calls that are shorter than the defined period of time in seconds will not be included into the calculation of Service Level"}},"description":"Call queue service level settings"},"editableMemberStatus":{"type":"boolean","description":"Allows members to change their queue status"}}}}}}},"x-api-group":"account/call-queues","x-app-permission":"EditExtensions","x-user-permission":"EditUserInfo","x-throttling-group":"Light","x-docs-level":"Public","x-feature":"EditExtensionInfo","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/401154466044/call-queues/401154469044\n\n{\n \"serviceLevelSettings\": {\n \"slaGoal\": 80,\n \"slaThresholdSeconds\": 60,\n \"includeAbandonedCalls\": true,\n \"abandonedThresholdSeconds\": 60\n }\n}\n\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"401154469044\",\n \"name\" : \"John Smith\",\n \"extensionNumber\" : \"103\",\n \"status\" : \"Enabled\",\n \"serviceLevelSettings\": {\n \"slaGoal\": 80,\n \"slaThresholdSeconds\": 60,\n \"includeAbandonedCalls\": true,\n \"abandonedThresholdSeconds\": 60\n },\n \"editableMemberStatus\": true\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-queues/{groupId}/members":{"get":{"tags":["Call Queues"],"summary":"Get Call Queue Members","description":"Returns call queue group members.","operationId":"listCallQueueMembers","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queue members resource"},"records":{"type":"array","description":"List of call queue members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call queue member"},"id":{"type":"integer","description":"Internal identifier of a call queue member"},"extensionNumber":{"type":"string","description":"Extension number of a call queue member"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-queues/members","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-throttling-group":"Light","x-docs-level":"Public","x-service-level":1000,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/call-queues/754234008/members\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/754224008/call-queues/754234008/members?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/754224008/extension/754227008\",\n \"id\": 754227008,\n \"extensionNumber\": \"103\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/754224008/extension/754226008\",\n \"id\": 754226008,\n \"extensionNumber\": \"102\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/754224008/call-queues/754234008/members?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/754224008/call-queues/754234008/members?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign":{"post":{"tags":["Call Queues"],"summary":"Assign Multiple Call Queue Members","description":"Updates a call queue group.","operationId":"assignMultipleCallQueueMembers","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Changes for the given group","content":{"application/json":{"schema":{"type":"object","properties":{"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}}}},"required":true},"responses":{"204":{"description":"Success","content":{}},"400":{"description":"Extension of type [${extensionType}] cannot be included into call queue","content":{}}},"x-api-group":"account/call-queues/call-queues","x-app-permission":"EditExtensions","x-user-permission":"Groups","x-feature":"EditGroups","x-throttling-group":"Heavy","x-docs-level":"Public","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/call-queues/41004/bulk-assign\n\n{\n \"addedExtensionIds\": [\n \"289481004\",\n \"289485004\"\n ],\n \"removedExtensionIds\": [\n \"289483004\",\n \"289487004\"\n ]\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-queues":{"put":{"tags":["Call Queues"],"summary":"Update User Call Queues","description":"Updates the list of call queues where the user is an agent. This is a full update request, which means that if any queue where the user is an agent is not mentioned in request, then the user is automatically removed from this queue.","operationId":"updateUserCallQueues","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of the queues where the extension is an agent","items":{"type":"object","properties":{"id":{"type":"string","description":"Call queue extension identifier"},"name":{"type":"string","description":"Call queue name (read-only)"}}}}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of the queues where the extension is an agent","items":{"type":"object","properties":{"id":{"type":"string","description":"Call queue extension identifier"},"name":{"type":"string","description":"Call queue name (read-only)"}}}}}}}}}},"x-service-name":"pas","x-service-interface":"rest","x-service-version":"v1","x-auth-required":true,"x-api-group":"extension/call-queues","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-user-permission":"JoinLeaveCallQueue","x-feature":"JoinLeaveCallQueue","x-app-permission":"Accounts","x-docs-level":"Public","x-internal-api":false,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/extension/~/call-queues\n\n{\n \"records\": [ {\n \"id\": \"12345678\"\n }, {\n \"id\": \"87654321\" \n } ]\n}\n","response":"HTTP 200 OK\n\n\n{\n \"records\": [ {\n \"id\": \"12345678\",\n \"name\": \"Bakery\"\n }, {\n \"id\": \"87654321\",\n \"name\": \"Cafe\"\n } ]\n}\n\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/department/{departmentId}/members":{"get":{"tags":["Call Queues"],"summary":"Get Department Member List","description":"Viewing user account info (including name, business name, address and phone number/account number). Please note, that this method is deprecated and legacy 'Department' entity corresponds to 'Call Queue' in modern RingCentral product terminology. In order to retrieve call queue members please use the following method `GET/restapi/v1.0/account/{accountId}/call-queues/{groupId}/members`.","operationId":"listDepartmentMembers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"departmentId","in":"path","description":"Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid). Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","required":true,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"uri":{"type":"string","description":"Link to the list of department members"},"records":{"type":"array","description":"List of department members extensions","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"deprecated":true,"x-api-group":"account/department/members","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/department/754234008/members\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/account/754224008/department/754234008/members?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/account/754224008/extension/754227008\",\n \"id\": 754227008,\n \"extensionNumber\": \"103\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/account/754224008/extension/754226008\",\n \"id\": 754226008,\n \"extensionNumber\": \"102\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/account/754224008/department/754234008/members?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/account/754224008/department/754234008/members?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [page] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [departmentId] is not found"}]}},"/restapi/v1.0/account/{accountId}/department/bulk-assign":{"post":{"tags":["Call Queues"],"summary":"Assign Multiple Department Members","description":"Adds and/or removes multiple call queue members. Please note, that this method is deprecated and legacy 'Department' entity corresponds to 'Call Queue' in modern RingCentral product terminology. In order to assign multiple call queue members please use the following method `POST/restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign`.","operationId":"assignMultipleDepartmentMembers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","properties":{"items":{"type":"array","items":{"type":"object","properties":{"departmentId":{"type":"string"},"addedExtensionIds":{"type":"array","items":{"type":"string"}},"removedExtensionIds":{"type":"array","items":{"type":"string"}}}}}}}}},"required":false},"responses":{"default":{"description":"successful operation","content":{}}},"deprecated":true,"x-api-group":"account/department","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"UserGroups","x-feature":"EditUserGroups","x-docs-level":"Public","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/289481004/department/bulk-assign\n\n{\n \"items\": [\n {\n \"departmentId\": \"289484004\",\n \"addedExtensionIds\": [\n \"289481004\",\n \"289485004\"\n ],\n \"removedExtensionIds\": [\n \"289483004\",\n \"289487004\"\n ]\n }\n ]\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users":{"get":{"tags":["Paging Only Groups"],"summary":"Get Paging Group Users","description":"Returns the list of users allowed to page this group.","operationId":"listPagingGroupUsers","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"pagingOnlyGroupId","in":"path","description":"Internal identifier of a paging group","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of users allowed to page the Paging Only group"},"records":{"type":"array","description":"List of users allowed to page the Paging Only group","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging group user extension"},"uri":{"type":"string","description":"Link to a paging group user extension"},"extensionNumber":{"type":"string","description":"Extension number of a paging group user"},"name":{"type":"string","description":"Name of a paging group user"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/paging-only-groups/users","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserInfo","x-feature":"ReadExtensionInfo","x-docs-level":"Public","x-service-level":1000,"x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/paging-only-groups/402361066008/users\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402361054008/paging-only-group/402361066008/users?page=1&perPage=100\",\n \"records\": [\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402361054008/extension/402361054008\",\n \"id\": \"402361054008\",\n \"extensionNumber\": \"101\",\n \"name\": \"Alice Smith\"\n },\n {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402361054008/extension/402361056008\",\n \"id\": \"402361056008\",\n \"extensionNumber\": \"102\",\n \"name\": \"Bob Johnson\"\n }\n ],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 100,\n \"totalElements\": 2,\n \"pageStart\": 0,\n \"pageEnd\": 1\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402361054008/paging-only-group/402361066008/users?page=1&perPage=100\"\n },\n \"lastPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402361054008/paging-only-group/402361066008/users?page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices":{"get":{"tags":["Paging Only Groups"],"summary":"Get Paging Group Devices","description":"Returns the list of paging devices assigned to this group.","operationId":"listPagingGroupDevices","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"pagingOnlyGroupId","in":"path","description":"Internal identifier of a paging group","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are accepted","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of devices assigned to the paging only group"},"records":{"type":"array","description":"List of paging devices assigned to this group","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a paging device"},"uri":{"type":"string","description":"Link to a paging device resource"},"name":{"type":"string","description":"Name of a paging device"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/paging-only-groups/devices","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyDevices","x-feature":"ReadAccountDevices","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/paging-only-groups/402439693008/devices?perPage=1\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402439675008/paging-only-group/402439693008/devices?page=1&perPage=1\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402439675008/device/400342469008\",\n \"id\" : \"400342469008\",\n \"name\" : \"My Paging Device #1\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 1,\n \"totalElements\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402439675008/paging-only-group/402439693008/devices?page=1&perPage=1\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402439675008/paging-only-group/402439693008/devices?page=1&perPage=1\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign":{"post":{"tags":["Paging Only Groups"],"summary":"Assign Paging Group Users and Devices","description":"Adds and/or removes paging group users and devices.","operationId":"assignMultiplePagingGroupUsersDevices","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"pagingOnlyGroupId","in":"path","description":"Internal identifier of a paging group","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"addedUserIds":{"type":"array","description":"List of users that will be allowed to page a group specified","items":{"type":"string"}},"removedUserIds":{"type":"array","description":"List of users that will be unallowed to page a group specified","items":{"type":"string"}},"addedDeviceIds":{"type":"array","description":"List of account devices that will be assigned to a paging group specified","items":{"type":"string"}},"removedDeviceIds":{"type":"array","description":"List of account devices that will be unassigned from a paging group specified","items":{"type":"string"}}}}}},"required":false},"responses":{"default":{"description":"Success","content":{}}},"x-api-group":"account/paging-only-groups/bulk-assign","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"Groups","x-feature":"EditGroups","x-docs-level":"Public","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/paging-only-groups/402439693008/bulk-assign\n\n{\n \"addedUserIds\": [\n \"402439675008\"\n ],\n \"removedUserIds\": [\n \"402439679008\"\n ],\n \"addedDeviceIds\": [\n \"400342469008\",\n \"400342465008\"\n ],\n \"removedDeviceIds\": [\n \"400342469778\"\n ]\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-monitoring-groups":{"get":{"tags":["Call Monitoring Groups"],"summary":"Get Call Monitoring Groups List","description":"Returns call monitoring groups that can be filtered by some extension.","operationId":"listCallMonitoringGroups","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}},{"name":"memberExtensionId","in":"query","description":"Internal identifier of an extension that is a member of every group within the result","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring groups resource"},"records":{"type":"array","description":"List of call monitoring group members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group resource"},"id":{"type":"string","description":"Internal identifier of a group"},"name":{"type":"string","description":"Name of a group"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-monitoring-groups","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-throttling-group":"Medium","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/403221597008/call-monitoring-groups?perPage=3\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403221597008/call-monitoring-groups?page=1&perPage=3\",\n \"records\" : [ {\n \"id\" : \"5790008\",\n \"name\" : \"Group #1\"\n }, {\n \"id\" : \"5791008\",\n \"name\" : \"Group #2\"\n }, {\n \"id\" : \"5792008\",\n \"name\" : \"Group #3\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 3,\n \"totalElements\" : 3,\n \"pageStart\" : 0,\n \"pageEnd\" : 2\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403221597008/call-monitoring-groups?page=1&perPage=3\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403221597008/call-monitoring-groups?page=1&perPage=3\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Call Monitoring Groups"],"summary":"Create Call Monitoring Group","description":"Creates a new call monitoring group.","operationId":"createCallMonitoringGroup","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters of a call monitoring group that will be created","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of a group"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group resource"},"id":{"type":"string","description":"Internal identifier of a group"},"name":{"type":"string","description":"Name of a group"}}}}}}},"x-api-group":"account/call-monitoring-groups","x-app-permission":"EditExtensions","x-user-permission":"Groups","x-feature":"EditGroups","x-throttling-group":"Medium","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/403510447008/call-monitoring-groups\n\n{\n \"name\": \"Group #1\"\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5894008\",\n \"id\" : \"5894008\",\n \"name\" : \"Group #1\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}":{"put":{"tags":["Call Monitoring Groups"],"summary":"Updates Call Monitoring Group","description":"Updates call monitoring group name by ID.","operationId":"updateCallMonitoringGroup","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Internal identifier of a call monitoring group","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Parameters of a call monitoring group that will be updated","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of a group"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group resource"},"id":{"type":"string","description":"Internal identifier of a group"},"name":{"type":"string","description":"Name of a group"}}}}}},"400":{"description":"Value for group name is unacceptable.","content":{}},"403":{"description":"User has no permissions to create groups.","content":{}},"404":{"description":"Group with the given identifier doesn't belong to the account.","content":{}}},"x-api-group":"account/call-monitoring-groups","x-app-permission":"EditExtensions","x-user-permission":"Groups","x-feature":"EditGroups","x-throttling-group":"Medium","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/403510447008/call-monitoring-groups/5893008\n\n{\n \"name\": \"Group #2\"\n \n}\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5893008\",\n \"id\" : \"5893008\",\n \"name\" : \"Group #2\"\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Monitoring Groups"],"summary":"Delete Call Monitoring Group","description":"Remove infromation about the given call monitoring group.","operationId":"deleteCallMonitoringGroup","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"404":{"description":"Group with the given identifier doesn't belong to the account.","content":{}}},"x-api-group":"account/call-monitoring-groups","x-app-permission":"EditExtensions","x-user-permission":"Groups","x-feature":"EditGroups","x-throttling-group":"Medium","x-docs-level":"Public","x-service-level":1000,"x-access-level":"Advanced","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/features":{"get":{"tags":["Features"],"summary":"Get User Features","description":"Returns the list of supported features and information on their availability for the current extension. Specific feature(s) might be checked by providing `featureId` query param. Multiple values supported, format: `?featureId=Feature1&featureId=Feature2`. To get only available features in order to decrease response size, `availableOnly=true` query param might be specified.\nIn case the feature is available for the current user, `\"available\": true` is returned in the response for the record with corresponding feature `id`. Otherwise, additional attribute `reason` is returned with the appropriate code:\n* `ServicePlanLimitation` - the feature not included to the account service plan;\n* `AccountLimitation` - the feature is turned off for the account;\n* `ExtensionTypeLimitation` - the feature is not applicable for the extension type;\n* `ExtensionLimitation` - the feature is not available for the extension, e.g., additional license required;\n* `InsufficientPermissions` - required permission not granted to the current user (not the one, who is specified in the URL, but the one who's access token is used);\n* `ConfigurationLimitation` - the feature is turned off for the extension, e.g., by the account administrator.\n\nAlso, some feature may have some additional parameters, e.g., limits, which are returned in `params` attribute as a name-value collection:\n\n {\n \"id\": \"HUD\",\n \"available\": true,\n \"params\": [\n {\n \"name\": \"limitMax\",\n \"value\": \"100\"\n }\n ]\n }","operationId":"readUserFeatures","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","required":true,"schema":{"type":"string"}},{"name":"availableOnly","in":"query","schema":{"type":"boolean","default":false}},{"name":"featureId","in":"query","style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Feature List","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a feature"},"available":{"type":"boolean","description":"Specifies if the feature is available for the current user according to services enabled for the account, type, entitlements and permissions of the extension. If the authorized user gets features of the other extension, only features that can be delegated are returned (such as configuration by administrators)."},"params":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Parameter name"},"value":{"type":"string","description":"Parameter value"}}}},"reason":{"type":"object","properties":{"code":{"type":"string","description":"Reason code","enum":["ServicePlanLimitation","AccountLimitation","ExtensionTypeLimitation","ExtensionLimitation","InsufficientPermissions","ConfigurationLimitation"]},"message":{"type":"string","description":"Reason description"},"permission":{"type":"string"}},"description":"Reason for the feature unavailability. Returned only if `available` is set to 'false'"}}}}}}}}}},"x-throttling-group":"Medium","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-api-group":"features","x-availability":"High","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/402638136004/extension/402638136004/features?availableOnly=true\n","response":"HTTP 200 OK\n\n{\n \"records\" : [ {\n \"id\" : \"CallScreening\",\n \"available\" : true\n }, {\n \"id\" : \"EditCallScreening\",\n \"available\" : true\n }, {\n \"id\" : \"SimultaneousRingingMode\",\n \"available\" : true\n }, {\n \"id\" : \"EditSimultaneousRingingMode\",\n \"available\" : true\n }, {\n \"id\" : \"RingGroups\",\n \"available\" : true\n }, {\n \"id\" : \"EditRingGroups\",\n \"available\" : true\n }, {\n \"id\" : \"ExternalForwarding\",\n \"available\" : true\n }, {\n \"id\" : \"EditExternalForwarding\",\n \"available\" : true\n }, {\n \"id\" : \"CallFlip\",\n \"available\" : true\n }, {\n \"id\" : \"EditCallFlip\",\n \"available\" : true\n }, {\n \"id\" : \"InboundCnam\",\n \"available\" : true\n }, {\n \"id\" : \"OnDemandCallRecording\",\n \"available\" : true\n }, {\n \"id\" : \"EditOnDemandCallRecording\",\n \"available\" : true\n }, {\n \"id\" : \"RingOut\",\n \"available\" : true\n }, {\n \"id\" : \"RingMe\",\n \"available\" : true\n }, {\n \"id\" : \"EditRingMe\",\n \"available\" : true\n }, {\n \"id\" : \"FaxSending\",\n \"available\" : true\n }, {\n \"id\" : \"EditFaxSettings\",\n \"available\" : true\n }, {\n \"id\" : \"FaxReceiving\",\n \"available\" : true\n }, {\n \"id\" : \"HardPhones\",\n \"available\" : true\n }, {\n \"id\" : \"EditHardPhones\",\n \"available\" : true\n }, {\n \"id\" : \"SoftPhones\",\n \"available\" : true\n }, {\n \"id\" : \"EditSoftPhones\",\n \"available\" : true\n }, {\n \"id\" : \"RCPhoneDesktop\",\n \"available\" : true\n }, {\n \"id\" : \"RCPhoneMobile\",\n \"available\" : true\n }, {\n \"id\" : \"RCAppDesktop\",\n \"available\" : true\n }, {\n \"id\" : \"RCAppMobile\",\n \"available\" : true\n }, {\n \"id\" : \"Glip\",\n \"available\" : true,\n \"params\" : [ {\n \"name\" : \"tabPosition\",\n \"value\" : \"First\"\n } ]\n }, {\n \"id\" : \"RCIntegrationApps\",\n \"available\" : true\n }, {\n \"id\" : \"ThirdPartyApps\",\n \"available\" : true\n }, {\n \"id\" : \"EditServiceStatusNotifications\",\n \"available\" : true\n }, {\n \"id\" : \"Calendar\",\n \"available\" : true\n }, {\n \"id\" : \"CallForwarding\",\n \"available\" : true\n }, {\n \"id\" : \"CallPark\",\n \"available\" : true\n }, {\n \"id\" : \"DND\",\n \"available\" : true\n }, {\n \"id\" : \"ExternalAuth\",\n \"available\" : true\n }, {\n \"id\" : \"HDVoice\",\n \"available\" : true\n }, {\n \"id\" : \"UserManagement\",\n \"available\" : true\n }, {\n \"id\" : \"Voicemail\",\n \"available\" : true\n }, {\n \"id\" : \"VoipCalling\",\n \"available\" : true\n }, {\n \"id\" : \"WebPhone\",\n \"available\" : true\n }, {\n \"id\" : \"SoftPhoneUpdate\",\n \"available\" : true\n }, {\n \"id\" : \"PromoMessage\",\n \"available\" : true\n }, {\n \"id\" : \"VoipCallingOnMobile\",\n \"available\" : true\n }, {\n \"id\" : \"AccountAdministration\",\n \"available\" : true\n }, {\n \"id\" : \"EditServiceWebAppearance\",\n \"available\" : true\n }, {\n \"id\" : \"EditCompanyInfo\",\n \"available\" : true\n }, {\n \"id\" : \"ReadCompanyInfo\",\n \"available\" : true\n }, {\n \"id\" : \"AccountValidation\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionGrants\",\n \"available\" : true\n }, {\n \"id\" : \"EditAssignedRoles\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAssignedRoles\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountPhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"EditDeviceOrders\",\n \"available\" : true\n }, {\n \"id\" : \"EditInternationalDestinations\",\n \"available\" : true\n }, {\n \"id\" : \"EditPaymentMethod\",\n \"available\" : true\n }, {\n \"id\" : \"ReadPaymentMethod\",\n \"available\" : true\n }, {\n \"id\" : \"EditServicePlan\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionGrants\",\n \"available\" : true\n }, {\n \"id\" : \"ReadServicePlan\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountDevices\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountDevices\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionDevices\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionDevices\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountPhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"AddRemovePhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionPhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"EditDirectoryAssistance\",\n \"available\" : true\n }, {\n \"id\" : \"EditGroups\",\n \"available\" : true\n }, {\n \"id\" : \"EditUsers\",\n \"available\" : true\n }, {\n \"id\" : \"EditRoles\",\n \"available\" : true\n }, {\n \"id\" : \"ReadRoles\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensions\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionInfo\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionInfo\",\n \"available\" : true\n }, {\n \"id\" : \"EditUserHours\",\n \"available\" : true\n }, {\n \"id\" : \"EditCredentials\",\n \"available\" : true\n }, {\n \"id\" : \"EditMessageAndNotificationSettings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadMessageAndNotificationSettings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadOutboundCallerId\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionPhonesAndNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"EditPersonalContacts\",\n \"available\" : true\n }, {\n \"id\" : \"ReadPersonalContacts\",\n \"available\" : true\n }, {\n \"id\" : \"DomesticCalling\",\n \"available\" : true\n }, {\n \"id\" : \"InternalCalling\",\n \"available\" : true\n }, {\n \"id\" : \"EditAutoReceptionist\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountAnsweringRules\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionPhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"EditOutboundCallerId\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountAnsweringRules\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountGreetings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountGreetings\",\n \"available\" : true\n }, {\n \"id\" : \"EditCallScreeningAndGreetings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadCallScreeningAndGreetings\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionAnsweringRules\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionAnsweringRules\",\n \"available\" : true\n }, {\n \"id\" : \"EditIncomingCallInfo\",\n \"available\" : true\n }, {\n \"id\" : \"CallTransfer\",\n \"available\" : true\n }, {\n \"id\" : \"Hold\",\n \"available\" : true\n }, {\n \"id\" : \"EditBlockedNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"ReadBlockedNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountCallRecordings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionCallRecordings\",\n \"available\" : true\n }, {\n \"id\" : \"ReadAccountCallLog\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountCallLogDelivery\",\n \"available\" : true\n }, {\n \"id\" : \"EditAccountCallLog\",\n \"available\" : true\n }, {\n \"id\" : \"ReadExtensionCallLog\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionCallLog\",\n \"available\" : true\n }, {\n \"id\" : \"EditExtensionCallLogDelivery\",\n \"available\" : true\n }, {\n \"id\" : \"EditPresenceStatus\",\n \"available\" : true\n }, {\n \"id\" : \"ReadPresenceStatus\",\n \"available\" : true\n }, {\n \"id\" : \"ReadMessages\",\n \"available\" : true\n }, {\n \"id\" : \"EditMessages\",\n \"available\" : true\n }, {\n \"id\" : \"ReadFaxSettings\",\n \"available\" : true\n }, {\n \"id\" : \"BotInstall\",\n \"available\" : true\n }, {\n \"id\" : \"BotUninstall\",\n \"available\" : true\n }, {\n \"id\" : \"ServiceWebAccess\",\n \"available\" : true\n }, {\n \"id\" : \"ReassignPhoneNumbers\",\n \"available\" : true\n }, {\n \"id\" : \"JoinLeaveCallQueue\",\n \"available\" : true\n }, {\n \"id\" : \"EditCallQueueMembers\",\n \"available\" : true\n }, {\n \"id\" : \"AddRemoveDevices\",\n \"available\" : true\n } ]\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [featureId] value is invalid."}]}},"/restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/members":{"get":{"tags":["Call Monitoring Groups"],"summary":"Get Call Monitoring Group Member List","description":"Returns call monitoring group members.","operationId":"listCallMonitoringGroupMembers","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Indicates the page number to retrieve. Only positive number values are allowed","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Indicates the page size (number of items)","schema":{"type":"integer","default":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records","uri"],"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group members resource"},"records":{"type":"array","description":"List of a call monitoring group members","items":{"type":"object","properties":{"uri":{"type":"string","description":"Link to a call monitoring group member"},"id":{"type":"string","description":"Internal identifier of a call monitoring group member"},"extensionNumber":{"type":"string","description":"Extension number of a call monitoring group member"},"permissions":{"type":"array","items":{"type":"string","description":"Call monitoring permission; mltiple values are allowed: * `Monitoring` - User can monitor a group * `Monitored` - User can be monitored\n","enum":["Monitoring","Monitored"]}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"account/call-monitoring-groups/members","x-app-permission":"ReadAccounts","x-user-permission":"ReadExtensions","x-feature":"ReadExtensions","x-throttling-group":"Medium","x-docs-level":"Public","x-availability":"High","x-service-level":1000,"x-http-examples":[{"request":"GET /restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/members?perPage=4\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/members?page=1&perPage=4\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/extension/403510447008\",\n \"id\" : \"403510447008\",\n \"extensionNumber\" : \"101\",\n \"permissions\" : [ \"Monitoring\", \"Monitored\" ]\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/extension/403510449008\",\n \"id\" : \"403510449008\",\n \"extensionNumber\" : \"102\",\n \"permissions\" : [ \"Monitored\" ]\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/extension/403510469008\",\n \"id\" : \"403510469008\",\n \"extensionNumber\" : \"109\",\n \"permissions\" : [ \"Monitoring\" ]\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/extension/403510471008\",\n \"id\" : \"403510471008\",\n \"extensionNumber\" : \"111\",\n \"permissions\" : [ \"Monitoring\" ]\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 2,\n \"perPage\" : 4,\n \"totalElements\" : 5,\n \"pageStart\" : 0,\n \"pageEnd\" : 3\n },\n \"navigation\" : {\n \"nextPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/members?page=2&perPage=4\"\n },\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/members?page=1&perPage=4\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/members?page=2&perPage=4\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/bulk-assign":{"post":{"tags":["Call Monitoring Groups"],"summary":"Update Call Monitoring Group List","description":"Updates call monitoring groups.","operationId":"updateCallMonitoringGroupList","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Changes for the given group","content":{"application/json":{"schema":{"type":"object","properties":{"addedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}},"updatedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}},"removedExtensions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension. Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited"},"permissions":{"type":"array","description":"Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value","items":{"type":"string","enum":["Monitoring","Monitored"]}}}}}}}}},"required":true},"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Extension of type [ParkLocation] could not be a member of [call monitoring]","content":{}}},"x-api-group":"account/call-monitoring-groups/bulk-assign","x-app-permission":"EditExtensions","x-user-permission":"Groups","x-feature":"EditGroups","x-throttling-group":"Heavy","x-docs-level":"Public","x-service-level":1000,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/403510447008/call-monitoring-groups/5893008/bulk-assign\n\n{\n \"addedExtensions\": [{\"id\": \"403510469008\", \"permissions\": [\"Monitoring\"]}, {\"id\": \"403510447008\", \"permissions\": [\"Monitoring\", \"Monitored\"]}],\n \"updatedExtensions\": [{\"id\": \"403510449008\", \"permissions\": [\"Monitored\"]}, {\"id\": \"403510471008\", \"permissions\": [\"Monitoring\"]}],\n \"removedExtensions\": [{\"id\": \"403510472008\"}, {\"id\": \"403510473008\"}]\n}\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension-bulk-update":{"post":{"tags":["Extensions"],"summary":"Update Multiple Extensions","description":"Updates multiple extensions at once. Maximum 500 extensions can be updated per request.","operationId":"extensionBulkUpdate","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["records"],"description":"List of extensions to be updated","type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","enum":["Disabled","Enabled","NotActivated","Frozen"]},"statusInfo":{"type":"object","properties":{"comment":{"type":"string","description":"A free-form user comment, describing the status change reason"},"reason":{"type":"string","description":"Type of suspension","enum":["Voluntarily","Involuntarily","SuspendedVoluntarily","SuspendedVoluntarily2"]}},"description":"Status information (reason, comment). Returned for 'Disabled' status only"},"reason":{"type":"string","description":"Type of suspension"},"comment":{"type":"string","description":"Free form user comment"},"extensionNumber":{"type":"string","description":"Extension number available"},"contact":{"type":"object","properties":{"firstName":{"type":"string","description":"For User extension type only. Extension user first name"},"lastName":{"type":"string","description":"For User extension type only. Extension user last name"},"company":{"type":"string","description":"Extension user company name"},"jobTitle":{"type":"string"},"email":{"type":"string","description":"Email of extension user"},"businessPhone":{"type":"string","description":"Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"mobilePhone":{"type":"string","description":"Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format"},"businessAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country name of an extension user company"},"state":{"type":"string","description":"State/province name of an extension user company. Mandatory for the USA, UK and Canada"},"city":{"type":"string","description":"City name of an extension user company"},"street":{"type":"string","description":"Street address of an extension user company"},"zip":{"type":"string","description":"Zip code of an extension user company"}},"description":"Extension user business address. The default is Company (Auto-Receptionist) settings"},"emailAsLoginName":{"type":"boolean","description":" If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is 'False'"},"pronouncedName":{"type":"object","properties":{"type":{"type":"string","description":"Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval)","enum":["Default","TextToSpeech","Recorded"]},"text":{"type":"string","description":"Custom text"},"prompt":{"type":"object","properties":{"id":{"type":"string"},"contentUri":{"type":"string","description":"Link to a prompt resource"},"contentType":{"type":"string","description":"Content media type","enum":["audio/mpeg","audio/wav"]}}}}},"department":{"type":"string","description":"Extension user department, if any"}}},"regionalSettings":{"type":"object","properties":{"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a country"}}},"timezone":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a timezone"}}},"language":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a language"}}},"greetingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"internal Identifier of a greeting language"}}},"formattingLocale":{"type":"object","properties":{"id":{"type":"string","description":"Internal Identifier of a formatting language"}}},"timeFormat":{"type":"string","description":"Time format setting","default":"12h","enum":["12h","24h"]}}},"setupWizardState":{"type":"string","enum":["NotStarted","Incomplete","Completed"]},"partnerId":{"type":"string","description":"Additional extension identifier created by partner application and applied on client side"},"ivrPin":{"type":"string","description":"IVR PIN"},"password":{"type":"string","description":"Password for extension"},"callQueueInfo":{"type":"object","properties":{"slaGoal":{"type":"integer","description":"Target percentage of calls that must be answered by agents within the service level time threshold"},"slaThresholdSeconds":{"type":"integer"},"includeAbandonedCalls":{"type":"boolean"},"abandonedThresholdSeconds":{"type":"integer"}},"description":"For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology"},"transition":{"type":"object","items":{"type":"object","properties":{"sendWelcomeEmailsToUsers":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the existing users during account confirmation"},"sendWelcomeEmail":{"type":"boolean","description":"Specifies if a welcome/activation email is sent to the new users (within extension status changing from 'Unsassigned' to 'NotActivated/Disabled')"}},"description":"For NotActivated extensions only. Welcome email settings"}},"customFields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a custom field"},"value":{"type":"string","description":"Custom field value"},"displayName":{"type":"string"}}}},"hidden":{"type":"boolean","description":"Hides extension from showing in company directory. Supported for extensions of User type only"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"uri":{"type":"string","description":"Link to a site resource"},"name":{"type":"string","description":"Name of a site"},"code":{"type":"string","description":"Site code value. Returned only if specified"}},"description":"Site data. If multi-site feature is turned on for the account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) site ID should be set to `main-site`"},"type":{"type":"string","description":"Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology","enum":["User","Fax User","VirtualUser","DigitalUser","Department","Announcement","Voicemail","SharedLinesGroup","PagingOnly","IvrMenu","ApplicationExtension","ParkLocation","DelegatedLinesGroup"]},"references":{"type":"array","description":"List of non-RC internal identifiers assigned to an extension","items":{"type":"object","properties":{"ref":{"type":"string","description":"Non-RC identifier of an extension"},"type":{"type":"string","description":"Type of external identifier","enum":["PartnerId","CustomerDirectoryId"]}}}}}}}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["creationTime","id","lastModifiedTime","status","uri"],"type":"object","description":"Information on a task for updating multiple extensions","properties":{"uri":{"type":"string","description":"Link to a task resource"},"id":{"type":"string","description":"Internal identifier of a task"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task latest update datetime"},"result":{"type":"object","description":"Result record on multiple extension update task","properties":{"affectedItems":{"type":"array","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","description":"Extension update status","enum":["Fail","Success"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}}}}}},"x-api-group":"account/extension-bulk-update","x-app-permission":"EditExtensions","x-user-permission":"EditExtensionInfo","x-feature":"EditExtensionInfo","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-team":"PLA IPA","x-beta-api":true,"x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension-bulk-update/tasks/{taskId}":{"get":{"tags":["Extensions"],"summary":"Get Update Task Status","description":"Returns the status of multiple extension update task","operationId":"getExtensionBulkUpdateTask","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["creationTime","id","lastModifiedTime","status","uri"],"type":"object","description":"Information on a task for updating multiple extensions","properties":{"uri":{"type":"string","description":"Link to a task resource"},"id":{"type":"string","description":"Internal identifier of a task"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task latest update datetime"},"result":{"type":"object","description":"Result record on multiple extension update task","properties":{"affectedItems":{"type":"array","items":{"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"status":{"type":"string","description":"Extension update status","enum":["Fail","Success"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}}}}}},"x-api-group":"account/extension-bulk-update","x-app-permission":"EditExtensions","x-user-permission":"EditExtensionInfo","x-feature":"EditExtensionInfo","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA IPA","x-http-examples":[{"request":"GET /restapi/v1.0/account/accountId/extension-bulk-update/tasks/147043006-147043006-5b3109afbd06443b840167d0808d8b4f\n","response":"HTTP 200 OK\n{\n \"id\": \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\": \"/restapi/v1.0/account/accountId/extension-bulk-update/tasks/147043006-147043006-5b3109afbd06443b840167d0808d8b4fI\",\n \"status\": \"Completed\",\n \"creationTime\": \"2019-02-20T13:30:09Z\",\n \"lastModifiedTime\": \"2019-02-20T13:30:09Z\",\n \"result\": {\n \"affectedItems\": [\n {\n \"extensionId\": \"123456789\",\n \"status\": \"Success\"\n },\n {\n \"extensionId\": \"987654321\",\n \"status\": \"Fail\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-000\",\n \"message\": \"Some msg here\"\n }\n ]\n }\n ],\n \"errors\": []\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/address-book-bulk-upload":{"post":{"tags":["External Contacts"],"summary":"Update Multiple Contacts","description":"Uploads multiple contacts for multiple extensions at once. Maximum 500 extension, each up to 10000 contacts, can be updated per request.","operationId":"addressBookBulkUpload","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["records"],"type":"object","properties":{"records":{"type":"array","description":"List of extensions which contacts have to be updated","items":{"required":["extensionId","contacts"],"type":"object","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contacts":{"type":"array","description":"List of contacts to be added to extension address book","items":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}}}}}}}}}},"required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"description":"Information on a task for adding multiple contacts to multiple extensions","required":["id","uri","creationTime","lastModifiedTime","status"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"uri":{"type":"string","description":"Link for the task status retrieval"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Datetime of a task creation"},"lastModifiedTime":{"type":"string","description":"Datetime of a task latest update"},"results":{"type":"object","description":"Result record on adding multiple contacts to an extension. Returned for completed tasks","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contact":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}},"status":{"type":"string","description":"Adding contact status","enum":["Success","Fail"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}}}}}},"x-api-group":"account/address-book-bulk-upload","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA IPA","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/accountId/address-book-bulk-upload\n{\n \"records\": [\n {\n \"extensionId\": \"123456789\",\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"jobTitle\": \"Director\",\n \"businessAddress\": {\n \"city\": \"New York\",\n \"country\": \"USA\"\n },\n \"homePhone\": \"+18763245477\"\n },\n ...\n ]\n }\n ]\n}\n","response":"HTTP 202 Accepted \n{\n \"id\": \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\": \"Task URL\",\n \"status\": \"Accepted\",\n \"creationTime\": \"2019-02-20T13:30:09Z\",\n \"lastModifiedTime\": \"2019-02-20T13:30:09Z\"\n} \n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/address-book-bulk-upload/tasks/{taskId}":{"get":{"tags":["External Contacts"],"summary":"Get Contacts Update Task","description":"Returns the status of a task on adding multiple contacts to multiple extensions.","operationId":"getAddressBookBulkUploadTask","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"description":"Information on a task for adding multiple contacts to multiple extensions","required":["id","uri","creationTime","lastModifiedTime","status"],"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a task"},"uri":{"type":"string","description":"Link for the task status retrieval"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed"]},"creationTime":{"type":"string","description":"Datetime of a task creation"},"lastModifiedTime":{"type":"string","description":"Datetime of a task latest update"},"results":{"type":"object","description":"Result record on adding multiple contacts to an extension. Returned for completed tasks","properties":{"extensionId":{"type":"string","description":"Internal identifier of an extension"},"contact":{"type":"object","description":"Contact resource","properties":{"email":{"type":"string","description":"Email of a contact","example":"charlie.williams@example.com"},"notes":{"type":"string","description":"Notes for a contact","example":"#1 Customer"},"company":{"type":"string","description":"Company name of a contact","example":"Example, Inc."},"firstName":{"type":"string","description":"First name of a contact","example":"Charlie"},"lastName":{"type":"string","description":"Last name of a contact","example":"Williams"},"jobTitle":{"type":"string","description":"Job title of a contact","example":"CEO"},"birthday":{"type":"string","description":"Date of birth of a contact","format":"date-time"},"webPage":{"type":"string","description":"Link to a contact home page","example":"http://www.example.com"},"middleName":{"type":"string","description":"Middle name of a contact","example":"J"},"nickName":{"type":"string","description":"Nick name of a contact","example":"The Boss"},"email2":{"type":"string","description":"Second email of a contact","example":"charlie-example@gmail.com"},"email3":{"type":"string","description":"Third email of a contact","example":"theboss-example@hotmail.com"},"homePhone":{"type":"string","description":"Home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"homePhone2":{"type":"string","description":"2nd home phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone":{"type":"string","description":"Business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessPhone2":{"type":"string","description":"2nd business phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"mobilePhone":{"type":"string","description":"Mobile phone of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessFax":{"type":"string","description":"Business fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"companyPhone":{"type":"string","description":"Company number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"assistantPhone":{"type":"string","description":"Phone number of a contact assistant in e.164 (with \"+\") format","example":"+15551234567"},"carPhone":{"type":"string","description":"Car phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherPhone":{"type":"string","description":"Other phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"otherFax":{"type":"string","description":"Other fax number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"callbackPhone":{"type":"string","description":"Callback phone number of a contact in e.164 (with \"+\") format","example":"+15551234567"},"businessAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"homeAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}},"otherAddress":{"type":"object","description":"Contact address information","properties":{"country":{"type":"string","description":"Country name of extension user company. Not returned for Address Book"},"state":{"type":"string","description":"State/province name of extension user company"},"city":{"type":"string","description":"City name of extension user company"},"street":{"type":"string","description":"Street address of extension user company"},"zip":{"type":"string","description":"Zip code of extension user company"}}}}},"status":{"type":"string","description":"Adding contact status","enum":["Success","Fail"]},"errors":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"parameterName":{"type":"string","description":"Name of invalid parameter"},"parameterValue":{"type":"string"}}}}}}}}}}}},"x-api-group":"account/address-book-bulk-upload","x-app-permission":"Contacts","x-user-permission":"EditPersonalContacts","x-feature":"EditPersonalContacts","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-beta-api":true,"x-team":"PLA IPA","x-http-examples":[{"request":"GET /restapi/v1.0/account/accountId/address-book-bulk-upload/tasks/147043006-147043006-5b3109afbd06443b840167d0808d8b4f\n","response":"HTTP 200 OK\n\n{\n \"id\": \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\": \"Task URL\",\n \"status\": \"Completed\",\n \"creationTime\": \"2019-02-20T13:30:09Z\",\n \"lastModifiedTime\": \"2019-02-20T13:30:09Z\",\n \"results\": [\n {\n \"extensionId\": \"123456789\",\n \"contact\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n ...\n },\n \"status\": \"Success\"\n },\n {\n \"extensionId\": \"123456789\",\n \"contact\": {\n \"firstName\": \"Alice\",\n \"lastName\": \"Williams\",\n ...\n },\n \"status\": \"Fail\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-101\", \n \"message\": \"message\": \"Parameter [n] value is invalid\"\n }\n ]\n }\n ]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/number-parser/parse":{"post":{"tags":["Phone Numbers"],"summary":"Parse Phone Number","description":"Returns one or more parsed and/or formatted phone numbers that are passed as a string.","operationId":"parsePhoneNumber","parameters":[{"name":"homeCountry","in":"query","description":"Internal identifier of a home country. The default value is ISO code (ISO 3166) of the user's home country or brand country, if the user is undefined","schema":{"type":"string"}},{"name":"nationalAsPriority","in":"query","description":"The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority","schema":{"type":"boolean"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"originalStrings":{"type":"array","description":"Phone numbers passed in a string. The maximum value of phone numbers is limited to 64. The maximum number of symbols in each phone number in a string is 64","items":{"type":"string"}}}}}},"required":true},"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["homeCountry","phoneNumbers"],"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a resource"},"homeCountry":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"phoneNumbers":{"type":"array","description":"Parsed phone numbers data","items":{"type":"object","properties":{"areaCode":{"type":"string","description":"Area code of location. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a specific geographic region/numbering area of the national numbering plan (NANP); that can be summarized as `NPA-NXX-xxxx` and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See [North American Numbering Plan] (https://en.wikipedia.org/wiki/North_American_Numbering_Plan) for details"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a country"},"uri":{"type":"string","description":"Canonical URI of a country"},"callingCode":{"type":"string","description":"Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes"},"emergencyCalling":{"type":"boolean","description":"Emergency calling feature availability/emergency address requirement indicator"},"isoCode":{"type":"string","description":"Country code according to the ISO standard, see ISO 3166"},"name":{"type":"string","description":"Official name of a country"}},"description":"Information on a user home country || Information on a country the phone number belongs to"},"dialable":{"type":"string","description":"Dialing format of a phone number"},"e164":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format"},"formattedInternational":{"type":"string","description":"International format of a phone number"},"formattedNational":{"type":"string","description":"Domestic format of a phone number"},"originalString":{"type":"string","description":"One of the numbers to be parsed, passed as a string in response"},"special":{"type":"boolean","description":"'True' if the number is in a special format (for example N11 code)"},"normalized":{"type":"string","description":"Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format without plus sign ('+')"},"tollFree":{"type":"boolean","description":"Specifies if a phone number is toll free or not"},"subAddress":{"type":"string","description":"Sub-Address. The portion of the number that identifies a subscriber into the subscriber internal (non-public) network."},"subscriberNumber":{"type":"string","description":" Subscriber number. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a subscriber in a network or numbering area."},"dtmfPostfix":{"type":"string","description":"DTMF (Dual Tone Multi-Frequency) postfix"}}}}}}}}}},"x-beta-api":true,"x-api-group":"number-parser/parse","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/number-parser/parse\n\n{\n \"originalStrings\": [\n \"8004699269\",\n \"6505234578\",\n \"+496704660908\",\n \"911\"\n ]\n}\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https:.../restapi/v1.0/number-parser/parse\",\n \"homeCountry\": {\n \"uri\": \"https:.../restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"phoneNumbers\": [\n {\n \"originalString\": \"8004699269\",\n \"country\": {\n \"uri\": \"https:.../restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"areaCode\": \"800\",\n \"formattedNational\": \"(800) 469-9269\",\n \"formattedInternational\": \"+1 (800) 469-9269\",\n \"dialable\": \"18004699269\",\n \"e164\": \"+18004699269\",\n \"special\": false,\n \"normalized\": \"18004699269\"\n },\n {\n \"originalString\": \"6505234578\",\n \"country\": {\n \"uri\": \"https:.../restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"areaCode\": \"650\",\n \"formattedNational\": \"(650) 523-4578\",\n \"formattedInternational\": \"+1 (650) 523-4578\",\n \"dialable\": \"16505234578\",\n \"e164\": \"+16505234578\",\n \"special\": false,\n \"normalized\": \"16505234578\"\n },\n {\n \"originalString\": \"+496704660908\",\n \"country\": {\n \"uri\": \"https:.../restapi/v1.0/dictionary/country/83\",\n \"id\": \"83\",\n \"name\": \"Germany\",\n \"isoCode\": \"DE\",\n \"callingCode\": \"49\"\n },\n \"areaCode\": \"\",\n \"formattedNational\": \"+49 6704660908\",\n \"formattedInternational\": \"+49 6704660908\",\n \"dialable\": \"011496704660908\",\n \"e164\": \"+496704660908\",\n \"special\": false,\n \"normalized\": \"496704660908\"\n },\n {\n \"originalString\": \"911\",\n \"country\": {\n \"uri\": \"https:.../restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\",\n \"isoCode\": \"US\",\n \"callingCode\": \"1\"\n },\n \"areaCode\": \"\",\n \"formattedNational\": \"911\",\n \"formattedInternational\": \"911\",\n \"dialable\": \"911\",\n \"e164\": \"911\",\n \"special\": true,\n \"normalized\": \"1911\"\n }\n ]\n}\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [nationalAsPriority] value is invalid."},{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/account/{accountId}/device/{deviceId}":{"get":{"tags":["Devices"],"summary":"Get Device","description":"Returns account device(s) by their ID(s).","operationId":"readDevice","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"deviceId","in":"path","description":"Internal identifier of a device","required":true,"schema":{"type":"integer"}},{"name":"syncEmergencyAddress","in":"query","description":"Specifies if emergency address should be synchronized or not","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"Account Device(s) Info","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["BLA","SoftPhone","OtherPhone","HardPhone","WebPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name"},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"billingStatement":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code complying with [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard"},"charges":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"feature":{"type":"string"},"freeServiceCredit":{"type":"number"}}}},"fees":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"freeServiceCredit":{"type":"number"}}}},"totalCharged":{"type":"number"},"totalCharges":{"type":"number"},"totalFees":{"type":"number"},"subtotal":{"type":"number"},"totalFreeServiceCredit":{"type":"number"}},"description":"Billing information. Returned for device update request if `prestatement` query parameter is set to 'true'"}}}}}}},"x-api-group":"account/device","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadCompanyDevices","x-feature":"ReadAccountDevices","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/device/155354004\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1113195004/device/155354004\",\n \"id\": \"155354004\",\n \"type\": \"HardPhone\",\n \"sku\": \"HP-16-2-2\",\n \"model\": {\n \"id\": \"16\",\n \"name\": \"Cisco SPA-508G Desk Phone\",\n \"addons\": [\n {\n \"id\": \"2\",\n \"name\": \"Cisco - 32 lines\",\n \"count\": 2\n }\n ],\n \"features\": [\n \"Intercom\",\n \"Paging\",\n \"BLA\"\n ]\n },\n \"name\": \"Cisco SPA-508G Desk Phone with 2 Expansion Modules\",\n \"status\": \"Offline\",\n \"phoneLines\": [],\n \"shipping\": {\n \"address\": {\n \"street\": \"20 Davis Drive\",\n \"city\": \"Belmont\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip\": \"123456\",\n \"customerName\": \"Dr. Watson\"\n },\n \"method\": {\n \"id\": \"2\",\n \"name\": \"2 Day\"\n },\n \"status\": \"Initial\"\n },\n \"linePooling\": \"None\"\n}\n"}],"x-error-codes":null},"put":{"tags":["Devices"],"summary":"Update Device","description":"Updates account device(s) by their ID(s).","operationId":"updateDevice","parameters":[{"name":"deviceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"prestatement","in":"query","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"country":{"type":"string","description":"Country name"},"countryId":{"type":"string","description":"Internal identifier of a country"}},"description":"Address for emergency cases. The same emergency address is assigned to all numbers of a single device. If the emergency address is also specified in `emergency` resource, then this value is ignored"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on extension that the device is assigned to"},"phoneLines":{"type":"object","properties":{"phoneLines":{"type":"array","description":"Information on phone lines added to a device","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone number"}}}}},"description":"Information on phone lines added to a device"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."}}}}},"required":false},"responses":{"default":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["BLA","SoftPhone","OtherPhone","HardPhone","WebPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name"},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"billingStatement":{"type":"object","properties":{"currency":{"type":"string","description":"Currency code complying with [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard"},"charges":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"feature":{"type":"string"},"freeServiceCredit":{"type":"number"}}}},"fees":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"amount":{"type":"number"},"freeServiceCredit":{"type":"number"}}}},"totalCharged":{"type":"number"},"totalCharges":{"type":"number"},"totalFees":{"type":"number"},"subtotal":{"type":"number"},"totalFreeServiceCredit":{"type":"number"}},"description":"Billing information. Returned for device update request if `prestatement` query parameter is set to 'true'"}}}}}}},"x-api-group":"account/device","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"EditAccounts","x-user-permission":"EditCompanyDevices","x-feature":"EditAccountDevices","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/device/138730004?prestatement=true\n\n{\n \"emergency\": {\n \"address\": {\n \"street\": \"20 DVS DRIVE\",\n \"street2\": \"FL 1\",\n \"city\": \"BELMONT\",\n \"stateId\": \"16\",\n \"state\": \"CA\",\n \"zip\": \"94002\",\n \"countryId\": \"1\",\n \"country\": \"US\",\n \"customerName\": \"...\"\n },\n \"location\": {}\n }\n}\n\n","response":"HTTP 200 OK\n\n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1033792004/device/138730004\",\n \"id\": \"138730004\",\n \"type\": \"HardPhone\",\n \"sku\": \"HP-16-2-2\",\n \"model\": {\n \"id\": \"16\",\n \"name\": \"Cisco SPA-508G Desk Phone\",\n \"addons\": [\n {\n \"id\": \"2\",\n \"name\": \"Cisco - 32 lines\",\n \"count\": 2\n }\n ],\n \"features\": [\n \"Intercom\",\n \"Paging\",\n \"BLA\"\n ]\n },\n \"name\": \"Cisco SPA-508G Desk Phone with 2 Expansion Modules\",\n \"status\": \"Offline\",\n \"extension\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/1033792004/extension/1033792004\",\n \"id\": 1033792004,\n \"extensionNumber\": \"101\"\n },\n \"billingStatement\": {\n \"currency\" : \"USD\",\n \"charges\": [{\n \"description\": \"Free Digital Line\",\n \"amount\": \"0.00\",\n \"feature\": \"DigitalLineFree\",\n \"freeServiceCredit\": \"0.00\"\n }\n ],\n \"totalCharges\" : \"0.00\",\n \"fees\": [{\n \"description\": \"e911 Service Fee\",\n \"amount\": \"0.99\",\n \"freeServiceCredit\": \"0.99\"\n }, {\n \"description\" : \"State and local taxes and fees\",\n \"amount\" : \"0.09\",\n \"freeServiceCredit\": \"0.09\"\n }\n ],\n \"totalFees\" : \"0.00\",\n \"subtotal\" : \"1.08\",\n \"totalFreeServiceCredit\": \"1.08\",\n \"totalCharged\" : \"0.00\"\n },\n \"phoneLines\": [\n {\n \"lineType\": \"Standalone\",\n \"emergencyAddress\": {\n \"required\": true,\n \"localOnly\": false\n },\n \"phoneInfo\": {\n \"id\": 894906004,\n \"phoneNumber\": \"+18002021371\",\n \"paymentType\": \"TollFree\",\n \"type\": \"VoiceFax\",\n \"usageType\": \"DirectNumber\",\n \"country\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\": \"1\",\n \"name\": \"United States\"\n }\n }\n }\n ],\n \"emergency\": {\n \"address\": {\n \"street\": \"20 DVS DRIVE\",\n \"street2\": \"FL 1\",\n \"city\": \"BELMONT\",\n \"stateId\": \"16\",\n \"state\": \"CA\",\n \"zip\": \"94002\",\n \"countryId\": \"1\",\n \"country\": \"US\",\n \"customerName\": \"Alice Smith\"\n },\n \"location\": {}\n },\n \"shipping\": {\n \"address\": {\n \"street\": \" 12 Street , 138\",\n \"city\": \"New York\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"zip\": \"123456\",\n \"customerName\": \"Alice Smith\"\n },\n \"method\": {\n \"id\": \"2\",\n \"name\": \"2 Day\"\n },\n \"status\": \"Initial\"\n },\n \"linePooling\": \"Host\"\n}\n"}],"x-error-codes":[{"httpCode":"403","errorCode":"CMN-401","message":"In order to call this API endpoint, application needs to have [EditAccounts] permission"},{"httpCode":"404","errorCode":"CMN-102","message":"Resource for parameter [accountId] is not found"}]}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/device":{"get":{"tags":["Devices"],"summary":"Get Extension Device List","description":"Returns devices of the extension(s) by their ID(s). Batch request is supported","operationId":"listExtensionDevices","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"linePooling","in":"query","description":"Pooling type of a device","schema":{"type":"string","enum":["Host","Guest","None"]}},{"name":"feature","in":"query","description":"Device feature or multiple features supported","schema":{"type":"string","enum":["Intercom","Paging","BLA","HELD"]}},{"name":"page","in":"query","description":"Number of a page to be returned","schema":{"type":"string","default":"1"}},{"name":"perPage","in":"query","description":"Number of records per page to be returned","schema":{"type":"string","default":"100"}}],"responses":{"default":{"description":"Success","content":{"application/json":{"schema":{"required":["navigation","paging","records"],"type":"object","properties":{"uri":{"type":"string","description":"Link to the list of extension devices"},"records":{"type":"array","description":"List of extension devices","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a device"},"uri":{"type":"string","description":"Canonical URI of a device"},"sku":{"type":"string","description":"Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2'"},"type":{"type":"string","description":"Device type","default":"HardPhone","enum":["SoftPhone","OtherPhone","HardPhone","Paging"]},"name":{"type":"string","description":"Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then device model name is used as device name "},"status":{"type":"string","description":"Device status","enum":["Offline","Online"]},"serial":{"type":"string","description":"Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications"},"computerName":{"type":"string","description":"PC name for softphone"},"model":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a HardPhone device model"},"name":{"type":"string","description":"Device name"},"addons":{"type":"array","description":"Addons description","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer"}}}},"features":{"type":"array","description":"Device feature or multiple features supported","items":{"type":"string","enum":["BLA","CommonPhone","Intercom","Paging","HELD"]}},"lineCount":{"type":"integer","description":"Max supported count of phone lines"}},"description":"HardPhone model information"},"extension":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of an extension","format":"int64"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"This attribute can be omitted for unassigned devices"},"emergencyServiceAddress":{"type":"object","properties":{"street":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"customerName":{"type":"string"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"taxId":{"type":"string","description":"Internal identifier of a tax"}},"description":"Address for emergency cases. The same emergency address is assigned to all the numbers of one device"},"emergency":{"type":"object","properties":{"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a customer"},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"zip":{"type":"string","description":"Zip code"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"}}},"location":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of the emergency response location"},"name":{"type":"string","description":"Location name"}},"description":"Company emergency response location details"},"outOfCountry":{"type":"boolean","description":"Specifies if emergency address is out of country"},"addressStatus":{"type":"string","description":"Emergency address status","enum":["Valid","Invalid"]},"syncStatus":{"type":"string","description":"Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to 'True'","enum":["Verified","Updated","Deleted","NotRequired","Unsupported","Failed"]},"addressEditableStatus":{"type":"string","description":"Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner)","enum":["MainDevice","AnyDevice"]}},"description":"Device emergency settings"},"phoneLines":{"type":"array","description":"Phone lines information","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a phone line"},"lineType":{"type":"string","description":"Type of phone line","enum":["Standalone","StandaloneFree","BlaPrimary","BlaSecondary"]},"phoneInfo":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a phone number","format":"int64"},"country":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a home country"},"uri":{"type":"string","description":"Canonical URI of a home country"},"name":{"type":"string","description":"Official name of a home country"}},"description":"Brief information on a phone number country"},"extension":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of an extension"},"uri":{"type":"string","description":"Canonical URI of an extension"},"extensionNumber":{"type":"string","description":"Number of extension"},"partnerId":{"type":"string","description":"For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension"}},"description":"Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list"},"label":{"type":"string","description":"Custom user name of a phone number, if any"},"location":{"type":"string","description":"Location (City, State). Filled for local US numbers"},"paymentType":{"type":"string","description":"Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system","enum":["External","TollFree","Local"]},"phoneNumber":{"type":"string","description":"Phone number"},"status":{"type":"string","description":"Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral"},"type":{"type":"string","description":"Phone number type","enum":["VoiceFax","FaxOnly","VoiceOnly"]},"usageType":{"type":"string","description":"Usage type of the phone number","enum":["MainCompanyNumber","AdditionalCompanyNumber","CompanyNumber","DirectNumber","CompanyFaxNumber","ForwardedNumber","ForwardedCompanyNumber","ContactCenterNumber"]}},"description":"Phone number information"},"emergencyAddress":{"type":"object","properties":{"required":{"type":"boolean","description":" 'True' if specifying of emergency address is required"},"localOnly":{"type":"boolean","description":" 'True' if only local emergency address can be specified"}}}}}},"shipping":{"type":"object","properties":{"status":{"type":"string","description":"Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally the status is changed to 'Shipped' which means that distributor shipped the device.","enum":["Initial","Accepted","Shipped","Won't ship"]},"carrier":{"type":"string","description":"Shipping carrier name. Appears only if the device status is 'Shipped'"},"trackingNumber":{"type":"string","description":"Carrier-specific tracking number. Appears only if the device status is 'Shipped'"},"method":{"type":"object","properties":{"id":{"type":"string","description":"Method identifier. The default value is 1 (Ground)","enum":["1","2","3"]},"name":{"type":"string","description":"Method name, corresponding to the identifier","enum":["Ground","2 Day","Overnight"]}},"description":"Shipping method information"},"address":{"type":"object","properties":{"customerName":{"type":"string","description":"Name of a primary contact person (receiver)"},"additionalCustomerName":{"type":"string","description":"Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerEmail":{"type":"string","description":"Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia."},"additionalCustomerEmail":{"type":"string","description":"Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia."},"customerPhone":{"type":"string","description":"Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia"},"additionalCustomerPhone":{"type":"string","description":"Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia."},"street":{"type":"string","description":"Street address, line 1 - street address, P.O. box, company name, c/o"},"street2":{"type":"string","description":"Street address, line 2 - apartment, suite, unit, building, floor, etc."},"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State/province name"},"stateId":{"type":"string","description":"Internal identifier of a state"},"stateIsoCode":{"type":"string","description":"ISO code of a state"},"stateName":{"type":"string","description":"Full name of a state"},"countryId":{"type":"string","description":"Internal identifier of a country"},"countryIsoCode":{"type":"string","description":"ISO code of a country"},"country":{"type":"string","description":"Country name"},"countryName":{"type":"string","description":"Full name of a country"},"zip":{"type":"string","description":"Zip code"},"taxId":{"type":"string","description":"National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number)."}},"description":"Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case the order contains several devices, they can be delivered to different addresses"}},"description":"Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer"},"boxBillingId":{"type":"integer","description":"Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone"},"useAsCommonPhone":{"type":"boolean","description":"Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone."},"linePooling":{"type":"string","description":"Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None']","enum":["Host","Guest","None"]},"inCompanyNet":{"type":"boolean","description":"Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined"},"site":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a site"},"name":{"type":"string","description":"Name of a site"}},"description":"Site data"},"lastLocationReportTime":{"type":"string","description":"Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z"}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}},"description":"Information on navigation"},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}},"description":"Information on paging"}}}}}}},"x-api-group":"extension/device","x-throttling-group":"Light","x-metered-api":true,"x-metering-group":"System","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserDevices","x-feature":"ReadExtensionDevices","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET /restapi/v1.0/account/403309665008/extension/1508193004,1508191004/device\n","response":"HTTP 207 \n\n--Boundary_3_1198574192_1484737481252\nContent-Type: application/json\n\n{\n \"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004/device?page=1&perPage=1\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n }, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508191004/device?page=1&perPage=2\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n } ]\n}\n--Boundary_3_1198574192_1484737481252\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004/device?page=1&perPage=1\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/device/228113004\",\n \"id\" : \"228113004\",\n \"type\" : \"HardPhone\",\n \"sku\" : \"HP-37\",\n \"model\" : {\n \"id\" : \"37\",\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"lineCount\" : 2,\n \"addons\" : [ ],\n \"features\" : [ ]\n },\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"status\" : \"Offline\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004\",\n \"id\" : 1508193004,\n \"extensionNumber\" : \"102\"\n },\n \"phoneLines\" : [ {\n \"id\" : \"110491004\",\n \"lineType\" : \"Standalone\",\n \"emergencyAddress\" : {\n \"required\" : true,\n \"localOnly\" : false\n },\n \"phoneInfo\" : {\n \"id\" : 1445481004,\n \"phoneNumber\" : \"+12028320504\",\n \"paymentType\" : \"Local\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"DirectNumber\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n }\n }\n } ],\n \"emergency\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"outOfCountry\" : false,\n \"addressStatus\" : \"Valid\"\n },\n \"emergencyServiceAddress\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\",\n \"outOfCountry\" : false\n },\n \"shipping\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"method\" : {\n \"id\" : \"2\",\n \"name\" : \"2 Day\"\n },\n \"status\" : \"Initial\"\n },\n \"linePooling\" : \"Host\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 1,\n \"totalElements\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004/device?page=1&perPage=1\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004/device?page=1&perPage=1\"\n }\n }\n}\n--Boundary_1_2099037130_1583408367977\nContent-Type: application/json\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508191004/device?page=1&perPage=2\",\n \"records\" : [ {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/device/228110004\",\n \"id\" : \"228110004\",\n \"type\" : \"HardPhone\",\n \"sku\" : \"HP-37\",\n \"model\" : {\n \"id\" : \"37\",\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"lineCount\" : 2,\n \"addons\" : [ ],\n \"features\" : [ ]\n },\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"status\" : \"Offline\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508191004\",\n \"id\" : 1508191004,\n \"extensionNumber\" : \"101\"\n },\n \"phoneLines\" : [ {\n \"id\" : \"110489004\",\n \"lineType\" : \"Standalone\",\n \"emergencyAddress\" : {\n \"required\" : true,\n \"localOnly\" : false\n },\n \"phoneInfo\" : {\n \"id\" : 1445479004,\n \"phoneNumber\" : \"+12513440557\",\n \"paymentType\" : \"Local\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"DirectNumber\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n }\n }\n } ],\n \"emergency\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"outOfCountry\" : false,\n \"addressStatus\" : \"Valid\"\n },\n \"emergencyServiceAddress\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\",\n \"outOfCountry\" : false\n },\n \"shipping\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"method\" : {\n \"id\" : \"2\",\n \"name\" : \"2 Day\"\n },\n \"status\" : \"Initial\"\n },\n \"linePooling\" : \"Host\"\n }, {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/device/228111004\",\n \"id\" : \"228111004\",\n \"type\" : \"HardPhone\",\n \"sku\" : \"HP-37\",\n \"model\" : {\n \"id\" : \"37\",\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"lineCount\" : 2,\n \"addons\" : [ ],\n \"features\" : [ ]\n },\n \"name\" : \"Polycom IP 6000 Conference Phone\",\n \"status\" : \"Offline\",\n \"extension\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508191004\",\n \"id\" : 1508191004,\n \"extensionNumber\" : \"101\"\n },\n \"phoneLines\" : [ {\n \"id\" : \"110490004\",\n \"lineType\" : \"Standalone\",\n \"emergencyAddress\" : {\n \"required\" : true,\n \"localOnly\" : false\n },\n \"phoneInfo\" : {\n \"id\" : 1445480004,\n \"phoneNumber\" : \"+12513440565\",\n \"paymentType\" : \"Local\",\n \"type\" : \"VoiceFax\",\n \"usageType\" : \"DirectNumber\",\n \"country\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/dictionary/country/1\",\n \"id\" : \"1\",\n \"name\" : \"United States\"\n }\n }\n } ],\n \"emergency\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"outOfCountry\" : false,\n \"addressStatus\" : \"Valid\"\n },\n \"emergencyServiceAddress\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\",\n \"outOfCountry\" : false\n },\n \"shipping\" : {\n \"address\" : {\n \"street\" : \"20 Davis Drive\",\n \"city\" : \"Belmont\",\n \"state\" : \"CA\",\n \"stateId\" : \"16\",\n \"stateIsoCode\" : \"CA\",\n \"stateName\" : \"California\",\n \"country\" : \"US\",\n \"countryId\" : \"1\",\n \"countryIsoCode\" : \"US\",\n \"countryName\" : \"United States\",\n \"zip\" : \"123456\",\n \"customerName\" : \"Dr. Watson\"\n },\n \"method\" : {\n \"id\" : \"2\",\n \"name\" : \"2 Day\"\n },\n \"status\" : \"Initial\"\n },\n \"linePooling\" : \"Host\"\n } ],\n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 2,\n \"totalElements\" : 2,\n \"pageStart\" : 0,\n \"pageEnd\" : 1\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004,1508191004/device?page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/1508191004/extension/1508193004,1508191004/device?page=1&perPage=100\"\n }\n }\n}\n\n"}],"x-error-codes":[{"httpCode":"400","errorCode":"CMN-101","message":"Parameter [perPage] value is invalid."},{"httpCode":"401","errorCode":"CMN-405","message":"Login to extension required"},{"httpCode":"401","errorCode":"OAU-151","message":"Authorization method not supported"}]}},"/scim/health":{"get":{"tags":["SCIM"],"summary":"Check Health","operationId":"checkHealth","responses":{"200":{"description":"healthy","content":{}}},"x-api-group":"scim/Health","x-auth-required":false,"x-throttling-group":"NoThrottling","x-docs-level":"Public","x-availability":"High","x-error-codes":null}},"/scim/v2/health":{"get":{"tags":["SCIM"],"summary":"Check Health","operationId":"checkHealth2","responses":{"200":{"description":"healthy","content":{}}},"x-api-group":"scim/Health","x-auth-required":false,"x-throttling-group":"NoThrottling","x-docs-level":"Public","x-availability":"High","x-error-codes":null}},"/scim/v2/ServiceProviderConfig":{"get":{"tags":["SCIM"],"summary":"Get Service Provider Config","operationId":"readServiceProviderConfig2","responses":{"200":{"description":"Service Provider Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}}},"bulk":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"etag":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"filter":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"patch":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"xmlDataFormat":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}}}}},"application/scim+json":{"schema":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}}},"bulk":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"etag":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"filter":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"patch":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"xmlDataFormat":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}}}}}}}},"x-api-group":"scim/ServiceProviderConfig","x-auth-required":false,"x-throttling-group":"NoThrottling","x-docs-level":"Public","x-availability":"High","x-error-codes":null}},"/scim/ServiceProviderConfig":{"get":{"tags":["SCIM"],"summary":"Get Service Provider Config","operationId":"readServiceProviderConfig","responses":{"200":{"description":"Service Provider Configuration","content":{"application/json":{"schema":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}}},"bulk":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"etag":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"filter":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"patch":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"xmlDataFormat":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}}}}},"application/scim+json":{"schema":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"documentationUri":{"type":"string"},"name":{"type":"string"},"specUri":{"type":"string"},"primary":{"type":"boolean"}}}},"bulk":{"type":"object","properties":{"maxOperations":{"type":"integer","format":"int32"},"maxPayloadSize":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"changePassword":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"etag":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"filter":{"type":"object","properties":{"maxResults":{"type":"integer","format":"int32"},"supported":{"type":"boolean","default":false}}},"patch":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"]}},"sort":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}},"xmlDataFormat":{"type":"object","properties":{"supported":{"type":"boolean","default":false}}}}}}}}},"x-api-group":"scim/ServiceProviderConfig","x-auth-required":false,"x-throttling-group":"NoThrottling","x-docs-level":"Public","x-availability":"High","x-error-codes":null}},"/scim/v2/Users":{"get":{"tags":["SCIM"],"summary":"Search/List Users","operationId":"searchViaGet2","parameters":[{"name":"filter","in":"query","description":"only support 'userName' or 'email' filter expressions for now","schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"start index (1-based)","schema":{"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"page size","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}},"application/scim+json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"ReadAccounts","x-throttling-group":"Light","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET scim/v2/Users?filter=&startIndex=1&count=3\n","response":"HTTP/1.1 200 OK\n\n{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n ],\n \"totalResults\": 10,\n \"startIndex\": 1,\n \"itemsPerPage\": 3,\n \"Resources\": [\n {\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"1271136020\",\n \"externalId\": \"ABCDEF-xxxcdf2\",\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2017-07-12T21:05:55.551Z\",\n \"lastModified\": \"2017-07-12T21:05:55.551Z\",\n \"location\": \"http://scim.ringcentral.com/scim/v2/Users/1271136020\"\n },\n \"userName\": \"john6.doe@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Doe\",\n \"givenName\": \"John6\"\n },\n \"active\": false,\n \"emails\": [\n {\n \"value\": \"john6.doe@mycompany.com\",\n \"type\": \"work\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"+16509186800\",\n \"type\": \"work\"\n },\n {\n \"value\": \"146\",\n \"type\": \"other\"\n }\n ],\n \"addresses\": [\n {\n \"streetAddress\": \"1400 Fashion Island Blvd, 7th Floor\",\n \"locality\": \"San Mateo\",\n \"region\": \"CA\",\n \"postalCode\": \"94404\",\n \"country\": \"United States\",\n \"type\": \"work\"\n }\n ]\n },\n {\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"1405111020\",\n \"externalId\": \"Lisa.Greene@acme.com\",\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2017-07-12T21:05:55.727Z\",\n \"lastModified\": \"2017-07-12T21:05:55.727Z\",\n \"location\": \"http://scim.ringcentral.com/scim/v2/Users/1405111020\"\n },\n \"userName\": \"Lisa.Greene@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Greene\",\n \"givenName\": \"Lisa\"\n },\n \"active\": false,\n \"emails\": [\n {\n \"value\": \"Lisa.Greene@mycompany.example.com\",\n \"type\": \"work\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"+16504899244\",\n \"type\": \"work\"\n },\n {\n \"value\": \"143\",\n \"type\": \"other\"\n }\n ],\n \"addresses\": []\n },\n {\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"1427379020\",\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2017-07-12T21:05:55.778Z\",\n \"lastModified\": \"2017-07-12T21:05:55.778Z\",\n \"location\": \"http://scim.ringcentral.com/scim/v2/Users/1427379020\"\n },\n \"userName\": \"Sonya.Anderson@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Anderson\",\n \"givenName\": \"Sonya\"\n },\n \"active\": true,\n \"emails\": [\n {\n \"value\": \"Sonya.Anderson@mycompany.example.com\",\n \"type\": \"work\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"167\",\n \"type\": \"other\"\n }\n ],\n \"addresses\": []\n }\n ]\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-129","message":"Access token corrupted"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"post":{"tags":["SCIM"],"summary":"Create User","operationId":"createUser2","requestBody":{"description":"a new user without 'id'","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"User status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"User status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}}},"required":false},"responses":{"201":{"description":"successfully created user","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"409":{"description":"duplicate email","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"EditAccounts","x-throttling-group":"Heavy","x-request-max-body-size":"10m","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /scim/v2/Users\n\n{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n ],\n \"externalId\": \"701985\",\n \"userName\": \"Jim.Bean@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Bean\",\n \"givenName\": \"Jim\"\n },\n \"emails\": [\n {\n \"type\": \"work\",\n \"value\": \"Jim.Bean@mycompany.example.com\"\n }\n ],\n \"addresses\": [\n {\n \"type\": \"work\",\n \"streetAddress\": \"100 Universal City Plaza\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"91608\",\n \"country\": \"US\"\n }\n ],\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\": {\n \"department\": \"Sales\"\n }\n}\n","response":"HTTP/1.1 201 OK\n\n{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n ],\n \"id\": \"1271140020\",\n \"externalId\": \"701985\",\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2017-02-14T18:29:01.194Z\",\n \"lastModified\": \"2017-02-14T18:29:01.194Z\",\n \"location\": \"http://scim.ringcentral.com/scim/v2/Users/1271140020\"\n },\n \"userName\": \"Jim.Bean@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Bean\",\n \"givenName\": \"Jim\"\n },\n \"active\": false,\n \"emails\": [\n {\n \"primary\": false,\n \"value\": \"Jim.Bean@mycompany.example.com\",\n \"type\": \"work\"\n }\n ],\n \"phoneNumbers\": [],\n \"addresses\": [\n {\n \"primary\": false,\n \"streetAddress\": \"100 Universal City Plaza\",\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"postalCode\": \"91608\",\n \"country\": \"United States\",\n \"type\": \"work\"\n }\n ],\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\": {\n \"department\": \"Sales\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/scim/Users":{"get":{"tags":["SCIM"],"summary":"Search/List Users","operationId":"searchViaGet","parameters":[{"name":"filter","in":"query","description":"only support 'userName' or 'email' filter expressions for now","schema":{"type":"string"}},{"name":"startIndex","in":"query","description":"start index (1-based)","schema":{"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"page size","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}},"application/scim+json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"ReadAccounts","x-throttling-group":"Light","x-docs-level":"Public","x-availability":"High","x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]},"post":{"tags":["SCIM"],"summary":"Create User","operationId":"createUser","requestBody":{"description":"New user without ID","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"User status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"User status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}}},"required":false},"responses":{"201":{"description":"successfully created user","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"409":{"description":"duplicate email","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"EditAccounts","x-throttling-group":"Heavy","x-request-max-body-size":"10m","x-docs-level":"Public","x-codegen-request-body-name":"body","x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/scim/v2/Users/.search":{"post":{"tags":["SCIM"],"summary":"Search/List Users","operationId":"searchViaPost2","requestBody":{"description":"search parameters","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"page size","format":"int32"},"filter":{"type":"string","description":"only support 'userName' or 'email' filter expressions for now"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]}},"startIndex":{"type":"integer","description":"start index (1-based)","format":"int32"}}}},"application/scim+json":{"schema":{"type":"object","properties":{"count":{"type":"integer","description":"page size","format":"int32"},"filter":{"type":"string","description":"only support 'userName' or 'email' filter expressions for now"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"]}},"startIndex":{"type":"integer","description":"start index (1-based)","format":"int32"}}}}},"required":false},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}},"application/scim+json":{"schema":{"type":"object","properties":{"Resources":{"type":"array","description":"user list","items":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]}},"startIndex":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"ReadAccounts","x-throttling-group":"Light","x-docs-level":"Public","x-availability":"High","x-codegen-request-body-name":"body","x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"}]}},"/scim/v2/Users/{id}":{"get":{"tags":["SCIM"],"summary":"Get User","operationId":"readUser2","parameters":[{"name":"id","in":"path","description":"user id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"ReadAccounts","x-throttling-group":"Light","x-docs-level":"Public","x-availability":"High","x-http-examples":[{"request":"GET scim/v2/Users/1271140020\n","response":"HTTP/1.1 200 OK\n\n{\n \"schemas\" : [ \"urn:ietf:params:scim:schemas:core:2.0:User\", \n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\" ],\n \"id\" : \"1271140020\",\n \"externalId\" : \"701985\",\n \"meta\" : {\n \"resourceType\" : \"User\",\n \"created\" : \"2017-02-14T18:29:01.194Z\",\n \"lastModified\" : \"2017-02-14T18:29:01.194Z\",\n \"location\" : \"http://scim.ringcentral.com/scim/v2/Users/1271140020\"\n },\n \"userName\" : \"Jim.Bean@mycompany.example.com\",\n \"name\" : {\n \"familyName\" : \"Bean\",\n \"givenName\" : \"Jim\"\n },\n \"active\" : false,\n \"emails\" : [ {\n \"primary\" : false,\n \"value\" : \"Jim.Bean@mycompany.example.com\",\n \"type\" : \"work\"\n } ],\n \"phoneNumbers\" : [ ],\n \"addresses\" : [ {\n \"primary\" : false,\n \"streetAddress\" : \"100 Universal City Plaza\",\n \"locality\" : \"Hollywood\",\n \"region\" : \"CA\",\n \"postalCode\" : \"91608\",\n \"country\" : \"United States\",\n \"type\" : \"work\"\n } ],\n \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\" : {\n \"department\" : \"Sales\"\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"put":{"tags":["SCIM"],"summary":"Update/Replace User","operationId":"replaceUser2","parameters":[{"name":"id","in":"path","description":"user id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"an existing user","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"}}}}},"required":false},"responses":{"200":{"description":"successfully fully updated a user","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"409":{"description":"duplicate email","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"EditAccounts","x-throttling-group":"Heavy","x-request-max-body-size":"10m","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT scim/v2/Users/1271136020\n\n{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"jeremy.doe@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Doe\",\n \"givenName\": \"Jeremy\"\n },\n \"active\": false,\n \"emails\": [\n {\n \"value\": \"jeremy.doe@mycompany.example.com\",\n \"type\": \"work\"\n }\n ],\n \"addresses\": [\n {\n \"streetAddress\": \"900 Main St\",\n \"locality\": \"Belmont\",\n \"region\": \"CA\",\n \"postalCode\": \"94002\",\n \"country\": \"United States\",\n \"type\": \"work\"\n }\n ]\n}\n","response":"HTTP/1.1 200 OK\n\n{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"1271136020\",\n \"meta\": {\n \"resourceType\": \"User\",\n \"created\": \"2017-07-12T21:16:32.262Z\",\n \"lastModified\": \"2017-07-12T21:16:32.262Z\",\n \"location\": \"http://scim.ringcentral.com/scim/v2/Users/1271136020\"\n },\n \"userName\": \"jeremy.doe@mycompany.example.com\",\n \"name\": {\n \"familyName\": \"Doe\",\n \"givenName\": \"Jeremy\"\n },\n \"active\": false,\n \"emails\": [\n {\n \"value\": \"jeremy.doe@mycompany.example.com\",\n \"type\": \"work\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"146\",\n \"type\": \"other\"\n }\n ],\n \"addresses\": [\n {\n \"streetAddress\": \"900 Main St\",\n \"locality\": \"Belmont\",\n \"region\": \"CA\",\n \"postalCode\": \"94002\",\n \"country\": \"United States\",\n \"type\": \"work\"\n }\n ]\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]},"delete":{"tags":["SCIM"],"summary":"Delete User","operationId":"deleteUser2","parameters":[{"name":"id","in":"path","description":"user id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"successfully deleted","content":{}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"EditAccounts","x-throttling-group":"Heavy","x-docs-level":"Public","x-http-examples":[{"request":"DELETE scim/v2/Users/16278940 \n","response":"HTTP/1.1 204 No Content\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]},"patch":{"tags":["SCIM"],"summary":"Update/Patch User","operationId":"patchUser2","parameters":[{"name":"id","in":"path","description":"user id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"patch operations list","content":{"application/json":{"schema":{"required":["Operations","schemas"],"type":"object","properties":{"Operations":{"type":"array","description":"patch operations list","items":{"required":["op"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"string"},"value":{"type":"string","description":"corresponding 'value' of that field specified by 'path'"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}}}},"application/scim+json":{"schema":{"required":["Operations","schemas"],"type":"object","properties":{"Operations":{"type":"array","description":"patch operations list","items":{"required":["op"],"type":"object","properties":{"op":{"type":"string","enum":["add","replace","remove"]},"path":{"type":"string"},"value":{"type":"string","description":"corresponding 'value' of that field specified by 'path'"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}}}}},"required":false},"responses":{"200":{"description":"successfully partially updated user","content":{"application/json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}},"application/scim+json":{"schema":{"required":["emails","name","schemas","userName"],"type":"object","properties":{"active":{"type":"boolean","description":"user status","default":false},"addresses":{"type":"array","items":{"required":["type"],"type":"object","properties":{"country":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"region":{"type":"string"},"streetAddress":{"type":"string"},"type":{"type":"string","enum":["work"]}}}},"emails":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work"]},"value":{"type":"string"}}}},"externalId":{"type":"string","description":"external unique resource id defined by provisioning client"},"id":{"type":"string","description":"unique resource id defined by RingCentral"},"name":{"required":["familyName","givenName"],"type":"object","properties":{"familyName":{"type":"string"},"givenName":{"type":"string"}}},"phoneNumbers":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["work","mobile","other"]},"value":{"type":"string"}}}},"photos":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["photo"]},"value":{"type":"string"}}}},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"]}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"type":"object","properties":{"department":{"type":"string"}}},"userName":{"type":"string","description":"MUST be same as work type email address"},"meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"type":"string","enum":["User","Group"]}},"description":"resource metadata"}}}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"404":{"description":"not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"409":{"description":"duplicate email","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}},"application/scim+json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"]}},"scimType":{"type":"string","description":"bad request type when status code is 400","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"]},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}}}}}}},"x-api-group":"scim/Users","x-app-permission":"EditAccounts","x-throttling-group":"Heavy","x-request-max-body-size":"10m","x-docs-level":"Public","x-codegen-request-body-name":"body","x-error-codes":[{"httpCode":"401","errorCode":"OAU-149","message":"Invalid token"},{"httpCode":"429","errorCode":"CMN-301","message":"Request rate exceeded"}]}},"/restapi/v1.0/account/{accountId}/telephony/call-out":{"post":{"tags":["Call Control"],"summary":"Make CallOut","description":"Creates a new outbound call out session. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Sessions/op_session_add_CallOut"},"operationId":"createCallOutCallSession","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["from","to"],"type":"object","properties":{"from":{"type":"object","properties":{"deviceId":{"type":"string","description":"Internal identifier of a device","example":"59474004"}},"description":"Instance id of the caller. It corresponds to the 1st leg of the CallOut call."},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number in E.164 format","example":16502223366},"extensionNumber":{"type":"string","description":"Extension number","example":"103"}},"description":"Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call session"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"voiceCallToken":{"type":"string","description":"For calls of 'Conference' type only"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}},"creationTime":{"type":"string","description":"Date and time of the latest session update represented in Unix time format"}},"description":"Call session information"}}}}}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-beta-api":true,"x-api-group":"telephony/call-out","x-throttling-group":"Heavy","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-failover-strategy":"Hardening","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/call-out","x-rewrite-uri-to":"/telephony/v1/account/$1/call-out","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/call-out\n\n{\n \"from\": {\n \"deviceId\": \"803469127021\"\n },\n \"to\": {\n \"phoneNumber\": \"+79817891689\"\n }\n}\n","response":"HTTP 201 Created\n\n {\n \"session\": {\n \"creationTime\": \"2019-08-19T11:42:21Z\",\n \"id\": \"s-54a38392c79849dab4a25fe8040edd53\",\n \"origin\": {\n \"type\": \"Call\"\n },\n \"parties\": [\n {\n \"direction\": \"Outbound\",\n \"from\": {\n \"deviceId\": \"803469127021\",\n \"extensionId\": \"297277020\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+18885287464\"\n },\n \"id\": \"p-54a38392c79849dab4a25fe8040edd53-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"37439510\",\n \"extensionId\": \"297277020\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Setup\"\n },\n \"to\": {\n \"phoneNumber\": \"+79817891689\"\n }\n }\n ]\n }\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/conference":{"post":{"tags":["Call Control"],"summary":"Start Conference Call Session","description":"Initiates a conference call session.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Sessions/op_session_add_Conference"},"operationId":"createConferenceCallSession","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call session"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"voiceCallToken":{"type":"string","description":"For calls of 'Conference' type only"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}},"creationTime":{"type":"string","description":"Date and time of the latest session update represented in Unix time format"}},"description":"Call session information"}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/conference","x-throttling-group":"Heavy","x-internal-api":false,"x-app-permission":"TelephonySessions","x-failover-strategy":"Hardening","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/conference","x-rewrite-uri-to":"/telephony/v1/account/$1/conference","x-docs-level":"Public","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/conference\n","response":"HTTP 201 Created\n{\n \"session\": {\n \"creationTime\": \"2020-10-08T07:35:19Z\",\n \"id\": \"s-aa5647de93294f039a9828ba103f115b\",\n \"origin\": {\n \"type\": \"Conference\"\n },\n \"parties\": [],\n \"voiceCallToken\": \"conf_732d61613536343764653933323934663033396139383238626131303366313135624031302e31342e3132332e31333a35303730\"\n }\n}\n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}":{"get":{"tags":["Call Control"],"summary":"Get Call Session Status","description":"Returns the status of a call session by ID.","operationId":"readCallSessionStatus","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","description":"The date and time of a call session latest change","schema":{"type":"string"}},{"name":"timeout","in":"query","description":"The time frame of awaiting for a status change before sending the resulting one in response","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call session"},"origin":{"type":"object","properties":{"type":{"type":"string","description":"Session origin type","enum":["Call","RingOut","RingMe","Conference","GreetingsRecording","VerificationCall","Zoom","CallOut"]}},"description":"Session origin details"},"voiceCallToken":{"type":"string","description":"For calls of 'Conference' type only"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}},"creationTime":{"type":"string","description":"Date and time of the latest session update represented in Unix time format"}},"description":"Call session information"}}}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2","x-beta-api":false,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzgxNTM2MTY1NDhAMTAuNjIuMS4zMA\n","response":"HTTP 200 OK\n{\n \"creationTime\": \"2018-08-01T13:36:09Z\",\n \"id\": \"Y3MxNzE4MzU2NzgxNTM2MTY1NDhAMTAuNjIuMS4zMA\",\n \"origin\": {\n \"type\": \"Call\"\n },\n \"parties\": [\n {\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"400415045004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"+18882101932\"\n },\n \"id\": \"cs171835678153616548-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"400415035004\",\n \"extensionId\": \"400415045004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"400415042004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"102\"\n }\n },\n {\n \"direction\": \"Inbound\",\n \"from\": {\n \"extensionId\": \"400415045004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n },\n \"id\": \"cs171835678153616548-2\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"400415035004\",\n \"extensionId\": \"400415042004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"400415042004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"102\"\n }\n }\n ]\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Control"],"summary":"Drop Call Session","description":"Drops a call session.","operationId":"deleteCallSession","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2","x-beta-api":false,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold":{"post":{"tags":["Call Control"],"summary":"Hold Call Party","description":"Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.","operationId":"holdCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/hold","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/hold","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/hold","x-beta-api":false,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4NDM0MTg2NTIyNjQ0M0AxMC42Mi4zMS45MA/parties/cs17184341865226443-1/hold\n","response":"HTTP 200 OK\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs17184341865226443-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Hold\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"},{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4NDM0MTg2NTIyNjQ0M0AxMC42Mi4zMS45MA/parties/cs17184341865226443-1/hold\n","response":"HTTP 200 OK\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs17184341865226443-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Hold\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/unhold":{"post":{"tags":["Call Control"],"summary":"Unhold Call Party","description":"Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.","externalDocs":{"description":"Find more info about response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_unhold"},"operationId":"unholdCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/unhold","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/unhold","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/unhold","x-beta-api":false,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4NDM0MTg2NTIyNjQ0M0AxMC42Mi4zMS45MA/parties/cs17184341865226443-1/unhold\n","response":"HTTP 200 OK\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs17184341865226443-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reject":{"post":{"tags":["Call Control"],"summary":"Reject Call Party","description":"Rejects an inbound call in a \"Setup\" or \"Proceeding\" state","operationId":"rejectParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/reject","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/reject","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/reject","x-beta-api":false,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/ignore":{"post":{"tags":["Call Control"],"summary":"Ignore Call in Queue","description":"Ignores a call to a call queue agent in `Setup` or `Proceeding` state.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+19.2#/Parties/op_party_ignore"},"operationId":"ignoreCallInQueue","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Internal device identifier","example":"400020454008"}}}}},"required":true},"responses":{"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}}},"x-beta-api":true,"x-api-group":"telephony/sessions/parties/ignore","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/ignore","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/ignore","x-docs-level":"Public","x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/transfer":{"post":{"tags":["Call Control"],"summary":"Transfer Call Party","description":"Transfers an answered call to the specified call party. Applicable for a call session in \"Answered\" or \"Hold\" state.","operationId":"transferCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Specifies a call party to which the call will be transfered. Only a single call party is allowed.","content":{"application/json":{"schema":{"type":"object","description":"Identifier of a call party the call will be transfered to. Only **one of** these parameters: `phoneNumber`, `voicemail`, `extensionNumber` or `parkOrbit` must be specified, otherwise an error is returned.","properties":{"phoneNumber":{"type":"string","description":"Phone number"},"voicemail":{"type":"string","description":"Voicemail owner extension identifier"},"parkOrbit":{"type":"string","description":"Park orbit identifier"},"extensionNumber":{"type":"string","description":"Number of extension"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/transfer","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/transfer","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/transfer","x-codegen-request-body-name":"body","x-beta-api":false,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzgzMDQ4MjY0MjFAMTAuNjIuMS4zMA/parties/cs171835678304826421-1/transfer\n\n{\n\"phoneNumber\":\"+12059690601\"\n}\n","response":"HTTP 200 OK\n\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs171835678304826421-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Disconnected\",\n \"reason\": \"BlindTransfer\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/bridge":{"post":{"tags":["Call Control"],"summary":"Bridge Call Party","description":"Allows the user to connect multiple call session participants over a conference call bridge. The current active call session ID and party ID of the user within this session should be specified in path; the bridged call session ID and party ID of the user within that session should be specified in request body. Thus the user connects participants of two sessions into one conference call using his/her own party IDs from both sessions.","operationId":"bridgeCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Defines target call session and call party to be bridged","content":{"application/json":{"schema":{"required":["partyId","telephonySessionId"],"type":"object","properties":{"telephonySessionId":{"type":"string","description":"Internal identifier of a call session to be connected to (bridged)"},"partyId":{"type":"string","description":"Internal identifier of a call party to be connected to (bridged)"}}}}},"required":true},"responses":{"200":{"description":"Bridged Call Info","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/bridge","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/bridge","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/bridge","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/s-4a2415b0c36c40a69ef6d45cf9e7108c/parties/p-4a2415b0c36c40a69ef6d45cf9e7108c-2/bridge\n\n{\n \"telephonySessionId\": \"s-f3ef1ea0096444848b1b14a0e85635fb\"\n \"partyId\": \"p-f3ef1ea0096444848b1b14a0e85635fb-1\"\n}\n","response":"HTTP 200 OK\n\n{ \n \"direction\": \"Inbound\",\n \"from\":\n { \n \"deviceId\": \"803872000020\",\n \"extensionId\": \"1606559020\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+16505428042\"\n },\n \"id\": \"p-4a2415b0c36c40a69ef6d45cf9e7108c-2\",\n \"muted\": false,\n \"owner\": { \n \"accountId\": \"37439510\",\n \"extensionId\": \"297277020\"\n },\n \"standAlone\": false,\n \"status\": { \n \"code\": \"Gone\",\n \"peerId\": { \n \"partyId\": \"p-f3ef1ea0096444848b1b14a0e85635fb-1\",\n \"telephonySessionId\": \"s-f3ef1ea0096444848b1b14a0e85635fb\"\n },\n \"reason\": \"AttendedTransfer\"\n },\n \"to\": { \n \"extensionId\": \"297277020\",\n \"name\": \"Jane Williams\",\n \"phoneNumber\": \"+16508370072\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/answer":{"post":{"tags":["Call Control"],"summary":"Answer Call Party","description":"Answers a call on a certain device by passing the corresponding device ID in request body. Supported for call forwarding, call transfer, call flip and call queues.","operationId":"answerCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Distributes a non-answered call to the defined target. Only a single target is allowed","content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"type":"string","description":"Device identifier that is used to answer the incoming call.","example":"400018633008"}}}}},"required":true},"responses":{"200":{"description":"Call Session Information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/answer","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/answer","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/answer","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /account/~/telephony/sessions/Y3MxNzE4MzU2NzkyNjEyMjgyMjJAMTAuNjIuMS4zMQ/parties/cs171835679261228222-2/answer\n\n {\n \"deviceId\" : \"1234567890\"\n }\n\n\n","response":" HTTP 200 OK\n\n {\n \"direction\": \"Inbound\",\n \"from\": {\n \"deviceId\": \"15426555020\",\n \"extensionId\": \"297277020\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+16508370072\"\n },\n \"id\": \"cs171835679261228222-2\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"1606559020\",\n \"extensionId\": \"1483173021\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Proceeding\"\n },\n \"to\": {\n \"deviceId\": \"1234567890\",\n \"extensionId\": \"1483173021\",\n \"name\": \"Jane Williams\",\n \"phoneNumber\": \"102\"\n }\n } \n\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/pickup":{"post":{"tags":["Call Control"],"summary":"Pickup Call","description":"Picks up a call parked to the specified park location.","operationId":"pickupCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Distributes a non-answered call to the defined target. Only a single target is allowed","content":{"application/json":{"schema":{"required":["deviceId"],"type":"object","properties":{"deviceId":{"type":"string","description":"Device identifier that is used to pick up the parked call.","example":"400018633008"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}}},"x-api-group":"telephony/sessions/parties/pickup","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/pickup","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/pickup","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /telephony/v1/account/{accountId}/sessions/{sessionId}/parties/{partyId}/pickup\n{\n \"deviceId\": \"803488717021\"\n}\n","response":"HTTP 200 OK\n{ \n \"direction\": \"Outbound\",\n \"from\": { \n \"deviceId\": \"754939004\",\n \"extensionId\": \"1606559020\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+16505428042\"\n },\n \"id\": \"cs1686300151516229687-4\",\n \"muted\": false,\n \"owner\": { \n \"accountId\": \"1606559020\",\n \"extensionId\": \"1606559020\"\n },\n \"standAlone\": false,\n \"status\": { \n \"code\": \"Answered\",\n \"reason\": \"Pickup\"\n },\n \"to\": { \n \"phoneNumber\":\"+79817891689\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/forward":{"post":{"tags":["Call Control"],"summary":"Forward Call Party","description":"Forwards a non-answered incoming call to the specified call party. Applicable for a call session in \"Setup\" or \"Proceeding\" state.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_forward"},"operationId":"forwardCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Specifies a call party to which the call will be forwarded. Only a single call party is allowed.","content":{"application/json":{"schema":{"type":"object","description":"Identifier of a call party the call will be forwarded to. Only **one of** these parameters: `phoneNumber`, `voicemail` or `extensionNumber` must be specified, otherwise an error is returned.","properties":{"phoneNumber":{"type":"string","description":"Phone number"},"voicemail":{"type":"string","description":"Voicemail owner extension identifier"},"extensionNumber":{"type":"string","description":"Number of an extension"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/forward","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/forward","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/forward","x-codegen-request-body-name":"body","x-beta-api":false,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2Nzc3MTIyNjQyMEAxMC42Mi4xLjI5/parties/cs17183567771226420-2/forward\n\n{\n\"phoneNumber\":\"+18882064931\"\n}\n","response":"HTTP 200 OK\n\n{\n \"direction\": \"Inbound\",\n \"from\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n },\n \"id\": \"cs17183567771226420-2\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Disconnected\",\n \"reason\": \"BlindTransfer\"\n },\n \"to\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"102\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reply":{"post":{"tags":["Call Control"],"summary":"Reply with Text","description":"Replies with text/pattern without picking up a call.","operationId":"replyParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"replyWithText":{"type":"string","description":"Text to reply"},"replyWithPattern":{"type":"object","properties":{"pattern":{"type":"string","description":"Predefined reply pattern name.","example":"OnMyWay","enum":["WillCallYouBack","CallMeBack","OnMyWay","OnTheOtherLine","WillCallYouBackLater","CallMeBackLater","InAMeeting","OnTheOtherLineNoCall"]},"time":{"type":"integer","description":"Number of time units. Applicable only to WillCallYouBack, CallMeBack patterns.","example":5},"timeUnit":{"type":"string","description":"Time unit name.","example":"Minute","enum":["Minute","Hour","Day"]}}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]}}}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Server is unable to process request just now","content":{}}},"x-api-group":"telephony/sessions/parties/reply","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/reply","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/reply","x-docs-level":"Public","x-beta-api":true,"x-codegen-request-body-name":"body","x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip":{"post":{"tags":["Call Control"],"summary":"Call Flip on Party","description":"Performs call flip procedure by holding opposite party and calling to the specified target","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_flip"},"operationId":"callFlipParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"callFlipId":{"type":"string","description":"Call flip id"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/flip","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/flip","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/flip","x-codegen-request-body-name":"body","x-beta-api":false,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park":{"post":{"tags":["Call Control"],"summary":"Call Park","description":"Parks a call to a virtual location from where it can further be retrieved by any user from any phone of the system. The call session and call party identifiers should be specified in path. Currently the users can park only their own incoming calls. Up to 50 calls can be parked simultaneously. Park location starts with asterisk (*) and ranges 801-899.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+11.0#/Parties/op_party_park"},"operationId":"callParkParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-beta-api":true,"x-api-group":"telephony/sessions/parties/park","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/park","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/park","x-http-examples":[{"request":"POST /restapi/v1.0/account/{accountId}/telephony/sessions/Y3MxNzE4MzU2NzkyNjEyMj/parties/cs171835679261228222-2/park\n","response":"201 Created\n\n{\n \"direction\": \"Inbound\",\n \"from\": {\n \"deviceId\": \"400017774008\",\n \"extensionId\": \"400130083008\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+18442097794\"\n },\n \"id\": \"cs171835679261228222-2\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"400130551008\",\n \"extensionId\": \"400130557008\"\n },\n \"park\": {\n \"id\": \"*813\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Parked\"\n },\n \"to\": {\n \"extensionId\": \"400130557008\",\n \"name\": \"Alice Williams\",\n \"phoneNumber\": \"+18772096679\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/bring-in":{"post":{"tags":["Call Control"],"summary":"Bring-In Call Party","description":"Adds a new party to the call session by bringing-in an established SIP call connection. The maximum number of parties to bring-in is 10; only 1 call party can be added per request. Currently the method is supported for sessions of 'Conference' origin only.","externalDocs":{"description":"Find more info about body and response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Add_Party/op_parties_add_bringIn"},"operationId":"createCallPartyWithBringIn","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["partyId","telephonySessionId"],"type":"object","properties":{"telephonySessionId":{"type":"string","description":"Internal identifier of a call session"},"partyId":{"type":"string","description":"Internal identifier of a party that should be added to the call session"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/bring-in","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"TelephonySessions","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/bring-in","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/bring-in","x-beta-api":true,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/s-aa5647de93294f039a9828ba103f115b/parties/bring-in\n\n { \n \"telephonySessionId\": \"s-aa5647de93294f039a9828ba103f115b\",\n \"partyId\": \"p-aa5647de93294f039a9828ba103f115b-01\"\n }\n\n","response":"HTTP 200 OK\n\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"John Smith\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"p-aa5647de93294f039a9828ba103f115b-01\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"Alice Williams\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}":{"get":{"tags":["Call Control"],"summary":"Get Call Party Status","description":"Returns a call party status by ID.","externalDocs":{"description":"Find more info about response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_get"},"operationId":"readCallPartyStatus","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3","x-beta-api":false,"x-http-examples":[{"request":"GET /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzYyOTU2MjkwMUAxMC42Mi4xLjI4/parties/cs17183567629562901-1\n","response":"HTTP 200 OK\n\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs17183567629562901-1\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null},"delete":{"tags":["Call Control"],"summary":"Delete Call Party","description":"Removes a party from a call session by ID. A party can be deleted only if supervised or parked. It is possible to delete only one conference participant per request.","operationId":"deleteCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"TelephonySessions","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3","x-beta-api":false,"x-error-codes":null},"patch":{"tags":["Call Control"],"summary":"Update Call Party","description":"Modifies a call party by ID. There is a known limitation for Mute scenario - mute via REST API doesn't work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and Ringcentral Desktop app you need to unmute both endpoints to bring the media back.","operationId":"updateCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"party":{"type":"object","properties":{"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"}},"description":"Party update data"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a party"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"park":{"type":"object","properties":{"id":{"type":"string","description":"Call park identifier"}},"description":"Call park information"},"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"direction":{"type":"string","description":"Direction of a call","enum":["Inbound","Outbound"]},"conferenceRole":{"type":"string","description":"A party's role in the conference scenarios. For calls of 'Conference' type only","enum":["Host","Participant"]},"ringOutRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only","enum":["Initiator","Target"]},"ringMeRole":{"type":"string","description":"A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only","enum":["Initiator","Target"]},"recordings":{"type":"array","description":"Active recordings list","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a recording resource"},"active":{"type":"boolean","description":"True if the recording is active. False if the recording is paused."}}}}},"description":"Information on a party of a call session"}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3","x-codegen-request-body-name":"body","x-beta-api":false,"x-http-examples":[{"request":"PATCH /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzYyOTU2MjkwMUAxMC42Mi4xLjI4/parties/cs17183567629562901-1\n\n{\n\"muted\" : true\n}\n","response":"HTTP 200 OK\n\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"extensionId\": \"404884534004\",\n \"name\": \"Tom Sawyer\",\n \"phoneNumber\": \"+18442089644\"\n },\n \"id\": \"cs17183567629562901-1\",\n \"muted\": true,\n \"owner\": {\n \"accountId\": \"404884532004\",\n \"extensionId\": \"404884534004\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\"\n },\n \"to\": {\n \"extensionId\": \"404884535004\",\n \"name\": \"TheCat Jerry\",\n \"phoneNumber\": \"103\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings":{"post":{"tags":["Call Control"],"summary":"Create Recording","description":"Starts a new call recording for the party","externalDocs":{"description":"Find more info about response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_addRecording"},"operationId":"startCallRecording","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/recordings","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/recordings","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/recordings","x-beta-api":false,"x-http-examples":[{"request":"POST /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzYyOTU2MjkwMUAxMC42Mi4xLjI4/parties/cs17183567629562901-1/recordings\n","response":"HTTP 200 OK\n\n{\n \"active\": true,\n \"id\": \"40003430000\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings/{recordingId}":{"patch":{"tags":["Call Control"],"summary":"Pause/Resume Recording","description":"Pause/resume recording","externalDocs":{"description":"Find more info about response format","url":"https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_modifyRecording"},"operationId":"pauseResumeCallRecording","parameters":[{"name":"brandId","in":"query","description":"Identifies a brand of a logged in user or a brand of a sign-up session","required":true,"schema":{"type":"string","default":"~"}},{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}},{"name":"recordingId","in":"path","description":"Internal identifier of a recording","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"type":"object","properties":{"active":{"type":"boolean","description":"Recording status"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a call recording"},"active":{"type":"boolean","description":"Call recording status"}}}}}},"400":{"description":"Bad Request","content":{}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/recordings","x-throttling-group":"Light","x-internal-api":false,"x-docs-level":"Public","x-app-permission":"CallControl","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/recordings/(.*)","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/recordings/$4","x-codegen-request-body-name":"body","x-beta-api":false,"x-http-examples":[{"request":"PATCH /restapi/v1.0/account/~/telephony/sessions/Y3MxNzE4MzU2NzYyOTU2MjkwMUAxMC42Mi4xLjI4/parties/cs17183567629562901-1/recordings/40003430000\n\n{\n\"active\": false\n}\n","response":"HTTP 200 OK\n\n{\n \"active\": false,\n \"id\": \"40003430000\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise":{"post":{"tags":["Call Control"],"summary":"Supervise Call Session","description":"Allows to monitor a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.","operationId":"superviseCallSession","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["mode","supervisorDeviceId"],"type":"object","properties":{"mode":{"type":"string","description":"Supervising mode","example":"Listen","enum":["Listen"]},"supervisorDeviceId":{"type":"string","description":"Internal identifier of a supervisor's device which will be used for call session monitoring","example":"191888004"},"agentExtensionNumber":{"type":"string","description":"Extension number of the user that will be monitored","example":"105"},"agentExtensionId":{"type":"string","description":"Extension identifier of the user that will be monitored","example":"400378008008"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that monitors a call"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information about a call party that is monitored"},"direction":{"type":"string","description":"Direction of a call","enum":["Outbound","Inbound"]},"id":{"type":"string","description":"Internal identifier of a party that monitors a call"},"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"},"muted":{"type":"boolean","description":"Specifies if a call participant is muted or not. **Note:** If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"standAlone":{"type":"boolean","description":"If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"}}}}}},"403":{"description":"Forbidden","content":{}},"404":{"description":"Not Found","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/supervise","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/supervise","x-beta-api":false,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /v1.0/account/3689920/telephony/sessions/s-c9fbe58a3b28416e9694a9ddaf8c18bf/supervise\n{ \n \"mode\": \"Listen\",\n \"agentExtensionId\": \"297277020\",\n \"supervisorDeviceId\": \"803872000020\"\n}\n","response":"HTTP 200 OK\n{\n \"direction\": \"Outbound\",\n \"from\": {\n \"deviceId\": \"803872000020\",\n \"name\": \"John Smith\",\n \"extensionId\": \"400130078008\",\n \"phoneNumber\": \"+18772096645\"\n },\n \"id\": \"cs171841903693222281-3\",\n \"muted\": false,\n \"owner\": {\n \"accountId\": \"400130073008\",\n \"extensionId\": \"400130078008\"\n },\n \"standAlone\": false,\n \"status\": {\n \"code\": \"Answered\",\n \"reason\": \"Supervising\"\n },\n \"to\": {\n \"phoneNumber\": \"+18772096347\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/supervise":{"post":{"tags":["Call Control"],"summary":"Supervise Call Party","description":"Allows to monitor a call party in 'Listen' mode. Input parameters are extension number of a monitored user and internal identifier of a supervisor's device. Call session and party identifiers should be specified in path. Please note that for this method dual channel audio flow is supported, which means that you need to make one more request for monitoring the second participant of a call. And as a result of each monitoring request the client recieves SIP invite with the following header `p-rc-api-monitoring-ids` containing IDs of the monitored party and session. The flow is supported for calls with no more than 2 participants. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.","operationId":"superviseCallParty","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"telephonySessionId","in":"path","description":"Internal identifier of a call session","required":true,"schema":{"type":"string"}},{"name":"partyId","in":"path","description":"Internal identifier of a call party","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON body","content":{"application/json":{"schema":{"required":["agentExtensionId","mode","supervisorDeviceId"],"type":"object","properties":{"mode":{"type":"string","description":"Supervising mode","example":"Listen","enum":["Listen"]},"supervisorDeviceId":{"type":"string","description":"Internal identifier of a supervisor's device","example":"191888004"},"agentExtensionId":{"type":"string","description":"Mailbox ID of a user that will be monitored","example":"400378008008"}}}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"to":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"Phone number of a party"},"name":{"type":"string","description":"Displayed name of a party"},"deviceId":{"type":"string","description":"Internal identifier of a device"},"extensionId":{"type":"string","description":"Internal identifier of an extension"}},"description":"Information on a calling/called party"},"direction":{"type":"string","description":"Direction of a call","enum":["Outbound","Inbound"]},"id":{"type":"string","description":"Internal identifier of a party that monitors a call"},"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"},"muted":{"type":"boolean","description":"Specifies if a call party is muted"},"owner":{"type":"object","properties":{"accountId":{"type":"string","description":"Internal identifier of an account that monitors a call"},"extensionId":{"type":"string","description":"Internal identifier of an extension that monitors a call"}},"description":"Deprecated. Information on call owner"},"standAlone":{"type":"boolean","description":"Specifies if a device is stand-alone"},"status":{"type":"object","properties":{"code":{"type":"string","description":"Status code of a call","enum":["Setup","Proceeding","Answered","Disconnected","Gone","Parked","Hold","VoiceMail","FaxReceive","VoiceMailScreening"]},"peerId":{"type":"object","properties":{"sessionId":{"type":"string"},"telephonySessionId":{"type":"string"},"partyId":{"type":"string"}},"description":"Peer session/party details. Valid in 'Gone' state of a call"},"reason":{"type":"string","description":"Reason for call termination. For 'Disconnected' code only","enum":["Pickup","Supervising","TakeOver","Timeout","BlindTransfer","RccTransfer","AttendedTransfer","CallerInputRedirect","CallFlip","ParkLocation","DtmfTransfer","AgentAnswered","AgentDropped","Rejected","Cancelled","InternalError","NoAnswer","TargetBusy","InvalidNumber","InternationalDisabled","DestinationBlocked","NotEnoughFunds","NoSuchUser","CallPark","CallRedirected","CallReplied","CallSwitch","CallFinished","CallDropped"]},"description":{"type":"string","description":"Optional message"}},"description":"Status data of a call session"}}}}}},"400":{"description":"Bad Request","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"Conflict","content":{}},"500":{"description":"Internal Server Error","content":{}},"503":{"description":"Service Temporary Unavailable","content":{}}},"x-api-group":"telephony/sessions/parties/supervise","x-throttling-group":"Light","x-internal-api":false,"x-app-permission":"CallControl","x-docs-level":"Public","x-rewrite-uri-from":"/restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/supervise","x-rewrite-uri-to":"/telephony/v1/account/$1/sessions/$2/parties/$3/supervise","x-beta-api":false,"x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /v1.0/account/40001234567890/telephony/sessions/s-171842208208020510/parties/p-171842208208020510-2/supervise\n{ \n \"mode\": \"Listen\",\n \"agentExtensionId\": \"40001234567890\",\n \"supervisorDeviceId\": \"191888004\"\n}\n","response":"HTTP 201 Created\n\n{ \n \"direction\":\"Outbound\",\n \"from\":\n { \n \"deviceId\":\"803872000020\",\n \"name\":\"John Smith\",\n \"extensionId\":\"400130078008\",\n \"phoneNumber\":\"+18772096645\"\n },\n\n \"id\":\"p-171842208208020510-3\",\n \"accountId\":\"400130073008\",\n \"extensionId\":\"400130078008\",\n \"muted\":false,\n \"owner\":\n { \n \"accountId\":\"400130073008\",\n \"extensionId\":\"400130078008\"\n },\n \"standAlone\":false,\n \"status\":\n { \n \"code\":\"Answered\",\n \"reason\":\"Supervising\"\n },\n \"to\":\n { \n \"phoneNumber\":\"+18772096347\"\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/data-export":{"get":{"tags":["Glip Compliance Exports"],"summary":"Get Data Export Task List","description":"Returns the list of Glip data export tasks.","operationId":"listDataExportTasks","parameters":[{"name":"status","in":"query","description":"Status of the task(s) to be returned. Multiple values are supported","schema":{"type":"string","enum":["Accepted","InProgress","Completed","Failed","Expired"]}},{"name":"page","in":"query","description":"Page number to be retrieved; value range is > 0","schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Number of records to be returned per page; value range is 1 - 250","schema":{"type":"integer","default":30}}],"responses":{"200":{"description":"Data Export Task List","content":{"application/json":{"schema":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a task"},"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task last modification datetime"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed","Expired"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"specific":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"datasets":{"type":"array","description":"Data collection sets. Returned by task ID","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}}}}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}}}}}}}},"x-api-group":"glip/compliance","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/data-export(.*)","x-rewrite-uri-to":"/glip/v1/data-export$1","x-docs-level":"Public","x-app-permission":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"request":"GET /restapi/v1.0/glip/data-export?status=InProgress&status=Completed\n","response":"HTTP 200 OK\n \n{\n \"tasks\": [{\n \"id\": \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"creationTime\": \"2018-04-20T13:30:09.023Z\",\n \"lastModifiedTime\": \"2018-04-20T13:30:09.023Z\",\n \"status\": \"InProgress\",\n \"creator\": {\n \"id\": \"512368\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"specific\": {\n \"timeFrom\": \"2019-11-18T14:00\",\n \"timeTo\": \"2019-12-18T14:00\",\n \"contacts\": [\n { \"id\": \"74623489\" },\n { \"email\": \"mycompany@example.com\" }\n ],\n \"chatIds\": [ \"13878234\", \"12923847\" ]\n }\n }, {\n \"id\": \"333\",\n \"uri\": \"https://platform.ringcentral.com/glip/data-export/333\",\n \"creationTime\": \"2016-03-20T22:01:01.023Z\",\n \"lastModifiedTime\": \"2016-03-20T22:31:01.023Z\",\n \"status\": \"Completed\",\n \"creator\": {\n \"id\": \"512368\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"specific\": {\n \"timeFrom\": \"2019-11-18T14:00\",\n \"timeTo\": \"2019-12-18T14:00\"\n },\n \"datasets\": [{\n \"id\": \"1\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/333/datasets/1\",\n \"size\": 2346788\n }]\n }],\n \"paging\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"perPage\": 30,\n \"totalElements\": 2,\n \"pageStart\" : 0,\n \"pageEnd\": 0\n },\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export?status=InProgress&status=Completed&page=1&perPage=30\"\n },\n \"lastPage\" : {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export?status=InProgress&status=Completed&page=1&perPage=30\"\n }\n }\n}\n"}],"x-error-codes":null},"post":{"tags":["Glip Compliance Exports"],"summary":"Create Data Export Task","description":"Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specified task ID. Simultaneously no more than 2 tasks per company can be created.","operationId":"createDataExportTask","requestBody":{"description":"JSON body","content":{"*/*":{"schema":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection. The default value is `timeTo` minus 24 hours. Max allowed time frame between `timeFrom` and `timeTo` is 6 months"},"timeTo":{"type":"string","description":"Ending time for data collection. The default value is current time. Max allowed time frame between `timeFrom` and `timeTo` is 6 months"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected. Maximum number of chats supported is 10","items":{"type":"string"}}}}}},"required":false},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a task"},"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task last modification datetime"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed","Expired"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"specific":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"datasets":{"type":"array","description":"Data collection sets. Returned by task ID","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}}}}}}}}},"x-api-group":"glip/data-export","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/data-export","x-rewrite-uri-to":"/glip/v1/data-export","x-throttling-group":"Heavy","x-app-permission":"Glip","x-docs-level":"Public","x-codegen-request-body-name":"body","x-beta-api":true,"x-http-examples":[{"request":"POST /restapi/v1.0/glip/data-export\n{\n \"timeFrom\": \"2019-11-18T14:00\",\n \"contacts\": [\n { \"id\": \"74623489\" },\n { \"email\": \"mycompany@example.com\" }\n ],\n \"chatIds\": [ \"13878234\", \"12923847\" ]\n}\n","response":"HTTP 202 Accepted\n \n{\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"id\": \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"creationTime\": \"2018-04-20T13:30:09Z\",\n \"lastModifiedTime\": \"2018-04-20T13:30:09Z\",\n \"status\": \"Accepted\",\n \"creator\": {\n \"id\": \"512368\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"specific\": {\n \"timeFrom\": \"2019-11-18T14:00\",\n \"timeTo\": \"2019-12-18T14:00\",\n \"contacts\": [\n { \"id\": \"74623489\" },\n { \"email\": \"mycompany@example.com\" }\n ],\n \"chatIds\": [ \"13878234\", \"12923847\" ]\n }\n}\n"}],"x-error-codes":[{"httpCode":"401","errorCode":"OAU-128","message":"Access token expired"},{"httpCode":"401","errorCode":"OAU-213","message":"Token not found"}]}},"/restapi/v1.0/glip/data-export/{taskId}":{"get":{"tags":["Glip Compliance Exports"],"summary":"Get Data Export Task","description":"Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned.","operationId":"readDataExportTask","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task to be retrieved","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"uri":{"type":"string","description":"Canonical URI of a task"},"id":{"type":"string","description":"Internal identifier of a task"},"creationTime":{"type":"string","description":"Task creation datetime"},"lastModifiedTime":{"type":"string","description":"Task last modification datetime"},"status":{"type":"string","description":"Task status","enum":["Accepted","InProgress","Completed","Failed","Expired"]},"creator":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a user who created a note/task"}},"description":"Note creator information"},"specific":{"type":"object","properties":{"timeFrom":{"type":"string","description":"Starting time for data collection"},"timeTo":{"type":"string","description":"Ending time for data collection"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a contact"},"email":{"type":"string","description":"Email address of a contact"}},"description":"List of users whose data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 10 users per request is supported."}},"chatIds":{"type":"array","description":"List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected","items":{"type":"string"}}},"description":"Information specififed in request"},"datasets":{"type":"array","description":"Data collection sets. Returned by task ID","items":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a dataset"},"uri":{"type":"string","description":"Link for downloading a dataset"},"size":{"type":"integer","description":"Size of ta dataset in bytes"}}}}}}}}}},"x-api-group":"glip/compliance","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/data-export/(.*)","x-rewrite-uri-to":"/glip/v1/data-export/$1","x-docs-level":"Public","x-app-permission":"Glip","x-throttling-group":"Medium","x-beta-api":true,"x-http-examples":[{"title":"Task In Progress","request":"GET /restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\n","response":"HTTP 200 OK\n\n{\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\", \n \"id\" : \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"creationTime\" : \"2018-04-20T13:30:09.023Z\",\n \"lastModifiedTime\" : \"2018-04-20T13:30:09.023Z\"\n \"status\" : \"InProgress\"\n}\n"},{"title":"Task Completed","request":"GET /restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\n","response":"HTTP 200 OK\n \n{\n \"id\" : \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"creationTime\" : \"2018-04-20T13:30:09.023Z\",\n \"lastModifiedTime\" : \"2018-04-20T13:30:09.023Z\",\n \"status\" : \"Completed\",\n \"creator\": {\n \"id\": \"512368\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\"\n },\n \"specific\": {\n \"timeFrom\": \"2019-11-18T14:00\",\n \"timeTo\": \"2019-12-18T14:00\"\n },\n \"datasets\": [{\n \"id\": \"1\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d/datasets/1\",\n \"size\": 73708885\n }, {\n \"id\": \"2\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/glip/data-export/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d/datasets/2\",\n \"size\": 106107\n }]\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/glip/data-export/{taskId}/datasets/{datasetId}":{"get":{"tags":["Glip Compliance Exports"],"summary":"Get Data Export Task Dataset","description":"Returns the specified dataset by ID. Each dataset is a ZIP archive the size of which is limited to 1 Gb.","operationId":"readDataExportTaskDataset","parameters":[{"name":"taskId","in":"path","description":"Internal identifier of a task","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"path","description":"Internal identifier of a dataset","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Dataset Zip Archive","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"glip/compliance","x-throttling-group":"Heavy","x-metered-api":true,"x-metering-group":"System","x-rewrite-uri-from":"/restapi/v1.0/glip/data-export/datasets(.*)","x-rewrite-uri-to":"/glip/v1/data-export/datasets/$1","x-docs-level":"Public","x-app-permission":"Glip","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/message-store-report":{"post":{"tags":["Message Exports"],"summary":"Create Message Store Report","description":"Creates a task to collect all account messages within the specified time interval. Maximum number of simaltaneous tasks per account is 2.","operationId":"createMessageStoreReport","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"dateFrom":{"type":"string","description":"Starting time for collecting messages. The default value equals to the current time minus 24 hours"},"dateTo":{"type":"string","description":"Ending time for collecting messages. The default value is the current time"}}}}},"required":false},"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message store report task"},"uri":{"type":"string","description":"Link to a task"},"status":{"type":"string","description":"Status of a message store report task","enum":["Accepted","Pending","InProgress","AttemptFailed","Failed","Completed","Cancelled"]},"accountId":{"type":"string","description":"Internal identifier of an account"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the last task modification"},"dateTo":{"type":"string","description":"Ending time for collecting messages"},"dateFrom":{"type":"string","description":"Starting time for collecting messages"}}}}}},"400":{"description":"Wrong request provided","content":{}},"503":{"description":"Internal error","content":{}}},"x-api-group":"message-store/task","x-app-permission":"ReadMessages","x-user-permission":"Users","x-feature":"EditUsers","x-docs-level":"Public","x-codegen-request-body-name":"body","x-throttling-group":"Heavy","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/message-store-report\n\n{\n \"dateFrom\": \"2015-11-18T14:28:53.000Z\"\n}\n","response":"HTTP 200 OK\n\n{\n \"id\" : \"402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402297343008/message-store-report/402297343008-402297343008-f674e48cbb5a479bac124ca8afcffb3d\",\n \"status\" : \"Accepted\",\n \"accountId\": \"402297343008\",\n \"extensionId\": \"402297343008\",\n \"creationTime\" : \"2018-04-20T13:30:09Z\",\n \"lastModifiedTime\" : \"2018-04-20T13:30:09Z\",\n \"dateFrom\": \"2015-11-18T14:28:53.000Z\",\n \"dateTo\": \"2018-04-20T13:30:09Z\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/message-store-report/{taskId}":{"get":{"tags":["Message Exports"],"summary":"Get Message Store Report Task","description":"Returns the current status of a task on report creation.","operationId":"readMessageStoreReportTask","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message store report task"},"uri":{"type":"string","description":"Link to a task"},"status":{"type":"string","description":"Status of a message store report task","enum":["Accepted","Pending","InProgress","AttemptFailed","Failed","Completed","Cancelled"]},"accountId":{"type":"string","description":"Internal identifier of an account"},"extensionId":{"type":"string","description":"Internal identifier of an extension"},"creationTime":{"type":"string","description":"Task creation time"},"lastModifiedTime":{"type":"string","description":"Time of the last task modification"},"dateTo":{"type":"string","description":"Ending time for collecting messages"},"dateFrom":{"type":"string","description":"Starting time for collecting messages"}}}}}}},"x-api-group":"message-store/task","x-app-permission":"ReadMessages","x-user-permission":"Users","x-feature":"EditUsers","x-docs-level":"Public","x-throttling-group":"Heavy","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/message-store-report/147043006-147043006-5b3109afbd06443b840167d0808d8b4f\n","response":"HTTP 200 OK\n\n{\n \n \"id\" : \"147043006-147043006-5b3109afbd06443b840167d0808d8b4f\",\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402297343008/message-store-report/147043006-147043006-5b3109afbd06443b840167d0808d8b4f\",\n \"status\" : \"InProgress\",\n \"accountId\": \"402297343008\",\n \"extensionId\": \"402297343008\",\n \"creationTime\" : \"2018-04-20T13:30:09Z\",\n \"lastModifiedTime\" : \"2018-04-20T13:30:09Z\",\n \"dateFrom\": \"2015-11-18T14:28:53.000Z\",\n \"dateTo\": \"2018-04-20T13:30:09Z\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive":{"get":{"tags":["Message Exports"],"summary":"Get Message Store Report Archive","description":"Returns the created report with message data not including attachments.","operationId":"readMessageStoreReportArchive","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"size":{"type":"integer","description":"Archive size in bytes"},"uri":{"type":"string","description":"Link for archive download"}}}}}}}}}},"x-api-group":"message-store/task/archive","x-app-permission":"ReadMessages","x-user-permission":"Users","x-feature":"EditUsers","x-docs-level":"Public","x-throttling-group":"Heavy","x-http-examples":[{"request":"GET /restapi/v1.0/account/402297343008/message-store-report/147043006-147043006-5b3109afbd06443b840167d0808d8b4f/archive\n","response":"HTTP 200 OK\n\n{\n \n \"records\": [ { \n \"size\": 106107,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402297343008/message-store-report/NDAyMjk3MzQzMDA4fDIwMTUtMTEtMThUMTQ6Mjg6NTMuMDAwWnwyMDE4LTA0LTIwVDEzOjMwOjA5Wg==/402297343008/archive/0\"\n }, {\n \"size\": 73708885,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/402297343008/message-store-report/NDAyMjk3MzQzMDA4fDIwMTUtMTEtMThUMTQ6Mjg6NTMuMDAwWnwyMDE4LTA0LTIwVDEzOjMwOjA5Wg==/402297343008/archive/1\"\n } ]\n\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive/{archiveId}":{"get":{"tags":["Message Exports"],"summary":"Get Message Store Report Archive Content","description":"Returns one of the report archives with message contents in application/zip format.","operationId":"readMessageStoreReportArchiveContent","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}},{"name":"archiveId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Archived Data","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}}},"x-api-group":"message-store/task/archive","x-app-permission":"ReadMessages","x-user-permission":"Users","x-feature":"EditUsers","x-docs-level":"Public","x-throttling-group":"Heavy","x-http-examples":[{"request":"GET /restapi/v1.0/account/402297343008/message-store-report/NDAyMjk3MzQzMDA4fDIwMTUtMTEtMThUMTQ6Mjg6NTMuMDAwWnwyMDE4LTA0LTIwVDEzOjMwOjA5Wg==/archive/1\n","response":"HTTP 200 OK\n\n[binary data]\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/meeting-recordings":{"get":{"tags":["Meeting Recordings"],"summary":"Get Account Meeting Recordings List","description":"Returns the list of meeting recordings for the current account.","operationId":"listAccountMeetingRecordings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"meetingId","in":"query","description":"Internal identifier of a meeting. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"meetingStartTimeFrom","in":"query","description":"Recordings of meetings started after the time specified will be returned. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"meetingStartTimeTo","in":"query","description":"Recordings of meetings started before the time specified will be returned. The default value is current time. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","schema":{"type":"integer"}},{"name":"perPage","in":"query","description":"Number of items per page. The `max` value is supported to indicate the maximum size - 300","schema":{"maximum":300,"type":"integer","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"meeting":{"type":"object","properties":{"id":{"type":"string"},"topic":{"type":"string"},"startTime":{"type":"string"}}},"recording":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentDownloadUri":{"type":"string","description":"Link for downloading the recorded file (mp4, mp3 audio and text/plain chat file)"},"contentType":{"type":"string","enum":["video/mp4","audio/m4a","text/plain"]},"size":{"type":"integer","format":"int32"},"startTime":{"type":"string","description":"Starting time of a recording"},"endTime":{"type":"string","description":"Ending time of a recording"},"status":{"type":"string","enum":["Completed","Processing"]}}}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}}}}}}}},"x-api-group":"account/meeting-recordings","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"MeetingsRecordings","x-feature":"MeetingsCompanyRecordings","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/meeting-recordings?meetingStartTimeFrom=2018-07-02T9:00:00Z \n","response":"HTTP 200 OK\n\n{\n\t\"records\": [ { \n \"meeting\": { \n \"id\": \"12345678\", \n \"topic\": \"Meeting Topic\", \n \"startTime\": \"2018-07-02T10:30:00Z\", \n }, \n \"recording\": { [ \n \"contentDownloadUri\": \"https://media.ringcentral.com/restapi/v1.0/account/402946441008/extension/402946446008/meeting/2sY6i6+0SFyCyapsM1NaKQ==/recordings/cc9b08e4-6103-44a2-80fc-c59f50b21d84/content\",\n \"contentType\": \"video/mp4\", \n \"size\": 432432, \n \"startTime\": \"2018-07-02T10:32:14Z\", \n \"endTime\": \"2018-07-02T11:12:27Z\", \n \"status\": \"Completed\" \n } ] \n }, ... ] \n\"paging\" : { \n \"page\" : 1, \n \"totalPages\" : 1, \n \"perPage\" : 100, \n \"totalElements\" : 1, \n \"pageStart\" : 0, \n \"pageEnd\" : 0 \n }, \n \"navigation\" : { \n \"firstPage\" : { \n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402946441008/meeting-recordings?meetingStartTimeFrom=2018-07-02T9:00:00Z&page=1&perPage=100\" \n }, \n \"lastPage\" : { \n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402946441008/meeting/?meetingStartTimeFrom=2018-07-02T9:00:00Z&page=1&perPage=100\" \n } \n } \n \n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting-recordings":{"get":{"tags":["Meeting Recordings"],"summary":"Get User Meeting Recordings List","description":"Returns the list of meetings recordings for the current user.","operationId":"listUserMeetingRecordings","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"extensionId","in":"path","description":"Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session","required":true,"schema":{"type":"string"}},{"name":"meetingId","in":"query","description":"Internal identifier of a meeting. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"meetingStartTimeFrom","in":"query","description":"Recordings of meetings started after the time specified will be returned. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"meetingStartTimeTo","in":"query","description":"Recordings of meetings started before the time specified will be returned. The default value is current time. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","schema":{"type":"integer"}},{"name":"perPage","in":"query","description":"Number of items per page. The `max` value is supported to indicate the maximum size - 300","schema":{"maximum":300,"type":"integer","default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"meeting":{"type":"object","properties":{"id":{"type":"string"},"topic":{"type":"string"},"startTime":{"type":"string"}}},"recording":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"contentDownloadUri":{"type":"string","description":"Link for downloading the recorded file (mp4, mp3 audio and text/plain chat file)"},"contentType":{"type":"string","enum":["video/mp4","audio/m4a","text/plain"]},"size":{"type":"integer","format":"int32"},"startTime":{"type":"string","description":"Starting time of a recording"},"endTime":{"type":"string","description":"Ending time of a recording"},"status":{"type":"string","enum":["Completed","Processing"]}}}}}}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested)"},"perPage":{"type":"integer","description":"Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied"},"pageStart":{"type":"integer","description":"The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty"},"pageEnd":{"type":"integer","description":"The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty"},"totalPages":{"type":"integer","description":"The total number of pages in a dataset. May be omitted for some resources due to performance reasons"},"totalElements":{"type":"integer","description":"The total number of elements in a dataset. May be omitted for some resource due to performance reasons"}}},"navigation":{"type":"object","properties":{"firstPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"nextPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"previousPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"},"lastPage":{"type":"object","properties":{"uri":{"type":"string"}},"description":"Canonical URI for the corresponding page of the list"}}}}}}}}},"x-api-group":"account/extension/meeting-recordings","x-throttling-group":"Medium","x-metered-api":true,"x-metering-group":"System","x-app-permission":"Meetings","x-user-permission":"MeetingsRecordings","x-feature":"MeetingsPersonalRecordings","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/extension/~/meeting-recordings?meetingStartTimeFrom=2018-07-02T9:00:00Z\n","response":"HTTP 200 OK\n\n{\n \"records\": [ { \n \"meeting\": { \n \"id\": \"12345678\", \n \"topic\": \"Meeting Topic\", \n \"startTime\": \"2018-07-02T10:30:00Z\", \n }, \n \"recording\": { [\n \"contentDownloadUri\": \"https://media.ringcentral.com/restapi/v1.0/account/402946441008/extension/402946446008/meeting/2sY6i6+0SFyCyapsM1NaKQ==/recordings/cc9b08e4-6103-44a2-80fc-c59f50b21d84/content\",\n \"contentType\": \"video/mp4\",\n \"size\": 432432,\n \"startTime\": \"2018-07-02T10:32:14Z\", \n \"endTime\": \"2018-07-02T11:12:27Z\", \n \"status\": \"Completed\" \n } ] \n }, ... ] \n \"paging\" : {\n \"page\" : 1,\n \"totalPages\" : 1,\n \"perPage\" : 100,\n \"totalElements\" : 1,\n \"pageStart\" : 0,\n \"pageEnd\" : 0\n },\n \"navigation\" : {\n \"firstPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402946441008/extension/402946446008/meeting-recordings?meetingStartTimeFrom=2018-07-02T9:00:00Z&page=1&perPage=100\"\n },\n \"lastPage\" : {\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/402946441008/extension/402946446008/meeting/?meetingStartTimeFrom=2018-07-02T9:00:00Z&page=1&perPage=100\"\n }\n }\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/custom-fields":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Field List","description":"Returns the list of created custom fields.","operationId":"listCustomFields","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"responses":{"200":{"description":"Custom Field List","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Custom field identifier"},"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}}}}}}}}},"x-api-group":"account/custom-fields/get","x-app-permission":"ReadAccounts","x-user-permission":"ReadUserInfo","x-feature":"EditUsers","x-throttling-group":"Light","x-docs-level":"Public","x-http-examples":[{"request":"GET /restapi/v1.0/account/~/custom-fields\n","response":"HTTP 200 OK\n\n{ \n \"records\":[ \n { \n \"id\": \"220001\",\n \"category\": \"Extension\",\n \"displayName\": \"Employee ID\"\n },\n { \n \"id\": \"220033\",\n \"category\": \"Extension\",\n \"displayName\": \"Tax number\"\n }\n ]\n}\n"}],"x-error-codes":null},"post":{"tags":["Custom Fields"],"summary":"Create Custom Field","description":"Creates custom field attached to the object.","operationId":"createCustomField","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}}}},"required":false},"responses":{"200":{"description":"Custom Field","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Custom field identifier"},"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}}}}}},"x-api-group":"account/custom-fields/create","x-app-permission":"EditAccounts","x-user-permission":"Users","x-feature":"EditUsers","x-throttling-group":"Light","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"POST /restapi/v1.0/account/~/custom-fields\n\n{ \n \"category\": \"User\",\n \"displayName\": \"Employee ID\"\n}\n","response":"HTTP 200 OK\n\n{ \n \"id\": \"220001\",\n \"category\": \"User\",\n \"displayName\": \"Employee ID\"\n}\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/custom-fields/{fieldId}":{"put":{"tags":["Custom Fields"],"summary":"Update Сustom Field","description":"Updates custom field by ID specified in path.","operationId":"updateCustomField","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"fieldId","in":"path","description":"Custom field identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":"Custom field display name"}}}}},"required":false},"responses":{"200":{"description":"Custom Field","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Custom field identifier"},"category":{"type":"string","description":"Object category to attach custom fields","enum":["User"]},"displayName":{"type":"string","description":"Custom field display name"}}}}}}},"x-api-group":"account/custom-fields/update","x-app-permission":"EditAccounts","x-user-permission":"Users","x-feature":"EditUsers","x-throttling-group":"Light","x-docs-level":"Public","x-codegen-request-body-name":"body","x-http-examples":[{"request":"PUT /restapi/v1.0/account/~/custom-fields/2200033\n\n{ \n \"displayName\": \"Employee ID\"\n}\n\n","response":"HTTP 200 OK\n\n{ \n \"id\": \"2200033\",\n \"category\": \"User\",\n \"displayName\": \"Employee ID\"\n}\n\n"}],"x-error-codes":null},"delete":{"tags":["Custom Fields"],"summary":"Delete Custom Field","description":"Deletes custom field(s) by ID(s) with the corresponding values.","operationId":"deleteCustomField","parameters":[{"name":"accountId","in":"path","description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","required":true,"schema":{"type":"string","default":"~"}},{"name":"fieldId","in":"path","description":"Custom field identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content","content":{}}},"x-api-group":"account/custom-fields/delete","x-app-permission":"EditAccounts","x-user-permission":"Users","x-feature":"EditUsers","x-throttling-group":"Light","x-docs-level":"Public","x-http-examples":[{"request":"DELETE /restapi/v1.0/account/~/custom-fields/2200033, 2200589\n","response":"HTTP 204 No Content\n"}],"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/a2p-sms/batch":{"post":{"tags":["High Volume SMS"],"summary":"Send A2P SMS","description":"Allows to send high volume of A2P (Application-to-Person) SMS messages (in message batches). Only phone number with the `A2PSmsSender` feature can be used as a sender.","operationId":"createA2PSMS","parameters":[{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}}],"requestBody":{"description":"SMS batch payload","content":{"application/json":{"schema":{"required":["from","messages"],"type":"object","properties":{"from":{"type":"string","description":"Sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format.","example":15551234567},"text":{"type":"string","description":"Text to send to `messages.to` phone numbers. Can be overridden on a per-message basis","example":"Hello, World!"},"messages":{"type":"array","description":"Individual messages","items":{"required":["to"],"type":"object","properties":{"to":{"type":"array","description":"List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format, recipients of this message. Currently only one number is supported","example":15551234567,"items":{"type":"string"}},"text":{"type":"string","description":"Text to send, maximum number of characters is 1000","example":"Hello, World!"}},"description":"Single individual SMS resource"}}},"description":"Batch of A2P SMS messages. This object provides specification to send message(s) to many recipients. It contains top-level attributes, such as `text` which apply to all `messages`. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients."}}}},"responses":{"201":{"description":"Message batch created","content":{"application/json":{"schema":{"required":["from","messages"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the message batch","readOnly":true,"example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent","example":15551234567},"batchSize":{"type":"integer","description":"Total number of messages in the accepted batch","example":5},"processedCount":{"type":"integer","description":"Total number of messages currently processed in the batch","example":1},"lastModifiedTime":{"type":"string","description":"The last time the batch was processed.\n","format":"date-time"},"status":{"type":"string","description":"Current status of a message batch","example":"Processing","enum":["Processing","Sent","Completed"]},"creationTime":{"type":"string","description":"The time at which the batch was created\n","format":"date-time"}},"description":"Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients"}}}},"400":{"description":"Validation Failed, Invalid Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"401":{"description":"Unauthorized error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Service is not available","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-codegen-request-body-name":"body","x-docs-level":"Public","x-auth-required":true,"x-service-version":"v1","x-service-interface":"rest","x-api-group":"asg/a2p-sms/batch","x-service-name":"asg","x-internal-api":false,"x-metered-api":false,"x-throttling-group":"Light","x-availability":"High","x-team":"PLA RnD","x-app-permission":"A2PSMS","x-feature":"SMSSending","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/a2p-sms/messages/{messageId}":{"get":{"tags":["High Volume SMS"],"summary":"Get A2P SMS","description":"Returns the details of an A2P SMS message by ID.","operationId":"readA2PSMS","parameters":[{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}},{"name":"messageId","in":"path","description":"Internal identifier of a message to be retrieved","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Message Infomation","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Internal identifier of a message","example":"1234"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message was sent","example":15551234567},"to":{"type":"array","description":"List of phone numbers in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which the message was sent","example":15551234567,"items":{"type":"string"}},"text":{"type":"string","description":"Text of a message, maximum number of characters is 1000","example":"Hello, World!"},"creationTime":{"type":"string","format":"date-time","description":"The time when this is message was created."},"lastModifiedTime":{"type":"string","format":"date-time","description":"The time when this message was last updated."},"messageStatus":{"type":"string","description":"Current status of a message","example":"Queued","enum":["Queued","Delivered","Sent","SendingFailed","DeliveryFailed"]},"segmentCount":{"type":"integer","description":"Number of segments of a message","format":"int64","example":1},"cost":{"type":"number","description":"Cost of a message","format":"double","example":0.007},"batchId":{"type":"string","description":"The batch in which the message was submitted","example":"batch12345"},"direction":{"type":"string","enum":["Inbound","Outbound"],"description":"Indicates whether the message is outbound or inbound","example":"out"},"errorCode":{"type":"string","description":"RC error code of the message sending failure reason","example":"SMS-RC-503"}},"description":"Detailed information on a message"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"401":{"description":"Unauthorized error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"404":{"description":"The message is not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Service is not available","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-docs-level":"Public","x-auth-required":true,"x-service-version":"v1","x-service-interface":"rest","x-api-group":"asg/a2p-sms/messages","x-service-name":"asg","x-internal-api":false,"x-metered-api":false,"x-throttling-group":"Light","x-availability":"High","x-team":"PLA RnD","x-app-permission":"A2PSMS","x-feature":"SMSSending","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/a2p-sms/batch/{batchId}":{"get":{"tags":["High Volume SMS"],"summary":"Get A2P SMS Batch","description":"Returns information on a message batch.","operationId":"readA2PBatch","parameters":[{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}},{"name":"batchId","in":"path","required":true,"description":"Internal identifier of a message batch to be retrieved","example":"55577","schema":{"type":"string"}}],"responses":{"200":{"description":"Message batch information","content":{"application/json":{"schema":{"required":["from","messages"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the message batch","readOnly":true,"example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent","example":15551234567},"batchSize":{"type":"integer","description":"Total number of messages in the accepted batch","example":5},"processedCount":{"type":"integer","description":"Total number of messages currently processed in the batch","example":1},"lastModifiedTime":{"type":"string","description":"The last time the batch was processed.\n","format":"date-time"},"status":{"type":"string","description":"Current status of a message batch","example":"Processing","enum":["Processing","Sent","Completed"]},"creationTime":{"type":"string","description":"The time at which the batch was created\n","format":"date-time"}},"description":"Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition to that, it is possible to override this attribute for each message. This way a single API call may be used to send individual messages to many recipients"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"401":{"description":"Unauthorized error","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"404":{"description":"The batch is not found","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Service is unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-docs-level":"Public","x-auth-required":true,"x-service-version":"v1","x-service-interface":"rest","x-api-group":"asg/a2p-sms/batch","x-service-name":"asg","x-internal-api":false,"x-metered-api":false,"x-throttling-group":"Light","x-availability":"High","x-team":"PLA RnD","x-app-permission":"A2PSMS","x-feature":"SMSSending","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/a2p-sms/messages":{"get":{"tags":["High Volume SMS"],"summary":"Get A2P SMS List","description":"Returns the list of outbound/inbound A2P messages sent from/to A2P phone numbers of the current account. The list can be filtered by message batch ID and/or phone number.","operationId":"listA2PSMS","parameters":[{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}},{"name":"batchId","required":false,"in":"query","description":"Internal identifier of a message batch used for filtering records","schema":{"type":"string"},"example":"1234"},{"name":"direction","in":"query","required":false,"description":"Direction of a message to filter the message list result. By default there is no filter applied - both Inbound and Outbound messages are returned","schema":{"type":"string","enum":["Inbound","Outbound"]},"example":"Outbound"},{"name":"view","in":"query","required":false,"description":"Indicates if the response has to be detailed, includes text in the response if detailed","schema":{"type":"string","default":"Simple","enum":["Simple","Detailed"]}},{"name":"dateFrom","in":"query","required":false,"description":"Date to filter message list result. Messages with `creationTime` later than or equal to `dateFrom` value are returned. The default value is 1 day before the current datetime","schema":{"type":"string"},"example":"2020-11-09T16:07:52.597Z"},{"name":"dateTo","in":"query","required":false,"description":"Date to filter message list result. Messages with `creationTime` earlier than `dateTo` value are returned. The default is the current datetime","schema":{"type":"string"},"example":"2020-11-25T16:07:52.597Z"},{"name":"phoneNumber","in":"query","required":false,"style":"form","explode":true,"description":"List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15","schema":{"type":"array","items":{"type":"string"}},"example":"phoneNumber=15551234455&phoneNumber=15551235577"},{"name":"pageToken","in":"query","required":false,"description":"Token of a page to be retrieved","schema":{"type":"string"},"example":"pgt1"},{"name":"perPage","in":"query","description":"Number of messages to be returned per request","schema":{"type":"integer","format":"int64","default":1000},"example":1}],"responses":{"200":{"description":"A2P SMS Message List","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"An array containing individual messages","items":{"type":"object","properties":{"id":{"type":"integer","description":"Internal identifier of a message","format":"int64","example":1234},"batchId":{"type":"string","description":"Internal identifier of a batch the message was submitted in","example":"12345"},"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message is sent","example":15551234567},"to":{"type":"array","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which a message is sent","example":15551234567,"items":{"type":"string"}},"creationTime":{"type":"string","format":"date-time","description":"The time at which the message was created"},"lastModifiedTime":{"type":"string","format":"date-time","description":"The time at which the messages was last updated"},"messageStatus":{"type":"string","description":"Current status of a message","example":"Queued","enum":["Queued","Delivered","Sent","SendingFailed","DeliveryFailed"]},"segmentCount":{"type":"integer","description":"Number of segments of a message","format":"int64","example":1},"text":{"type":"string","description":"Text of a message. Returned if the `view` parameter is set to 'Detailed'"},"cost":{"type":"number","description":"Cost of a message","format":"double","example":0.007},"direction":{"type":"string","enum":["Inbound","Outbound"],"description":"Indicates whether the message was outbound or inbound","example":"out"},"errorCode":{"type":"string","description":"The RC error code of the message sending failure reason","example":"SMS-RC-503"}},"description":"Infomation on a message returned within the specified batch"}},"paging":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"}},"description":"List of messages retrieved for an account and other filter criteria such as `batchId` and `fromPhoneNumber` specified in the request"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"404":{"description":"No resource found for the account.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-docs-level":"Public","x-auth-required":true,"x-service-version":"v1","x-service-interface":"rest","x-api-group":"asg/a2p-sms/messages","x-service-name":"asg","x-internal-api":false,"x-metered-api":false,"x-throttling-group":"Light","x-availability":"High","x-team":"PLA RnD","x-app-permission":"A2PSMS","x-feature":"SMSSending","x-beta-api":true,"x-error-codes":null}},"/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs":{"get":{"tags":["High Volume SMS"],"summary":"Get Opted Out Numbers","description":"Returns the list of numbers opted out from the account. The list can be filtered by `to`/`from` phone number query parameters. Specifying `text/csv` in the Accept header downloads the data in CSV format.","operationId":"readA2PSMSOptOuts","parameters":[{"name":"accountId","in":"path","required":true,"description":"Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session","example":"123324769","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"The sender's phone number (`from` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages","schema":{"type":"string"},"example":"15551234455"},{"name":"to","in":"query","required":false,"description":"The reciever's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages","example":"15551237755","schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"Token of the page to be retrieved","schema":{"type":"string"}},{"name":"perPage","in":"query","description":"Number of records to be returned for the page","schema":{"type":"integer","format":"int64","default":1000},"example":5}],"responses":{"200":{"description":"The list of opt records for the account filtered by the search criteria provided as query param","content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of individual opt-out number records","items":{"type":"object","properties":{"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the recipient has opted out","example":15551234567},"to":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format which is opted out","example":15551234567}},"description":"Opt-out record"}},"paging":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"}},"description":"Opt-out phone numbers information"}},"text/csv":{"schema":{"type":"object","properties":{"records":{"type":"array","description":"List of individual opt-out number records","items":{"type":"object","properties":{"from":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the recipient has opted out","example":15551234567},"to":{"type":"string","description":"Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format which is opted out","example":15551234567}},"description":"Opt-out record"}},"paging":{"type":"object","properties":{"pageToken":{"type":"string","description":"Page token of the current response list","example":"pgt1"},"perPage":{"type":"integer","description":"Number of records per page","example":3},"firstPageToken":{"type":"string","description":"First page token of the current filter criteria","example":"fpgt1"},"previousPageToken":{"type":"string","description":"Previous page token of the current filter criteria","example":"lpgt1"},"nextPageToken":{"type":"string","description":"Next page token of the current filter criteria","example":"npgt1"}},"description":"Pagination details"}},"description":"Opt-out phone numbers information"}}}},"400":{"description":"Invalid Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"404":{"description":"No resource found for the account","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}},"500":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","description":"Collection of all gathered errors","readOnly":true,"items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Code that characterizes this error. Code uniqly identifies the source of the error.","readOnly":true},"message":{"type":"string","description":"Message that describes the error. This message can be used in UI.","readOnly":true}},"description":"Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed"}}},"description":"Format of response in case that any error occured during request processing"}}}}},"x-docs-level":"Public","x-auth-required":true,"x-service-version":"v1","x-service-interface":"rest","x-api-group":"asg/a2p-sms/opt-outs","x-service-name":"asg","x-internal-api":false,"x-metered-api":false,"x-throttling-group":"Light","x-availability":"High","x-team":"PLA RnD","x-app-permission":"A2PSMS","x-feature":"SMSSending","x-beta-api":true,"x-error-codes":null}}},"x-chapters":[{"title":"Welcome","x-tag-group":"Using the API","description":"\n*The RingCentral Connect Platform API* can be accessed at `https://platform.ringcentral.com`. \nIf you work with non-production servers you should use other entry points. For example, RingCentral Sandbox environment is accessible at `https://platform.devtest.ringcentral.com.`\nIf you are not sure which URI to use for your environment, please contact [RingCentral Technical Support](https://developers.ringcentral.com/support.html) to get proper connection settings.\n*Please note* that for security reasons connection is only allowed using HTTPS protocol to the default HTTPS port #443, so the port can be omitted in the URI.\n\n**API resources** are organized in a hierarchical manner and presented in a tree-like structure.\n**All paths** are started from `/restapi`. \n**A typical link to API resource** looks as follows: `https://platform.ringcentral.com/restapi/v1.0/account/159048008/extension/171857008/call-log?dateFrom=2017-08-26`\n*Please note* that RingCentral users associate an account with the company main phone number and an extension with the short extension number, but both *accountId* and *extensionId* are internal identifiers.\n**A typical API usage scenario** includes accessing particular resources on behalf of a user whose credentials (phone number, extension number and password) were passed on authentication phase. \nIn this case the API enables simplified syntax of specifying account and extension identifiers by the tilde symbol (~). It can be used as a replacement for both *accountId* and *extensionId* if you are going to access data that belongs to account/extension you are currently logged in to. \nFor example, if the user successfully authenticated with the account #159048008 and extension #171857008 then the URI to retrieve the call log resource may be written as follows: `https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~/call-log?dateFrom=2017-08-26`.\n"},{"title":"Changelog","x-tag-group":"Using the API","description":"\n","children":[{"title":"2021 Feb (21.1)","description":"*1.0.46*\n\n* 🔐 **advanced**: appropriate App Permission has *Advanced* access level - API available to 3rd party developers by request;\n* ⚠️ potential **compatibility breaker**;\n* ⭐️ new API methods introduced;\n* ⛔️ API methods deprecated;\n* 🔧 bug fixes.\n\n---\n\n### Voice\n\n#### Call Handling Rules\n\n* Filter by Custom type in Call Handling rules API\n|Changed Methods|\n|-----------|\n| `GET /account/~/extension/~/answering-rule?type=Custom`|\n\n---\n\n#### Call Recording Settings\n\n* retention details are supported\n\n|Changed Methods|\n|-----------|\n| `GET /account/{accountId}/call-recording`|\n\n---\n\n### Account\n\n#### User Settings\n\n* new 'groupCallpickup' extension type supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension`|\n|`GET /account/{accountId}/extension/{extensionId}`|\n|`PUT /account/{accountId}/extension/{extensionId}`|\n\n---\n\n### Address Book\n\n#### Internal Contacts\n\n* new 'groupCallpickup' extension type supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/accountId/directory/entries`|\n|`GET /account/accountId/directory/entries/{entryId}`|\n|`GET /account/accountId/directory/entries/search`|\n\n---\n\n### Events & Notifications\n\n#### Notification Types\n\n* `sipData` query parameter is supported for telephony/session notifications \n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/telephony/sessions?sipData=true`]|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}telephony/sessions?sipData=true`]|\n\n---\n\n* new event filter for DND change is supported\n\n|New Event Filters|\n|---------------------|\n|⭐️ [`/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/dnd`]|\n\n---\n\n"},{"title":"2020 Nov (20.4)","description":"*1.0.45*\n\n* 🔐 **advanced**: appropriate App Permission has *Advanced* access level - API available to 3rd party developers by request;\n* ⚠️ potential **compatibility breaker**;\n* ⭐️ new API methods introduced;\n* ⛔️ API methods deprecated;\n* 🔧 bug fixes.\n\n---\n\n### Voice \n\n#### Call Handling Rules\n\n* call queue member name is now available\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/answering-rule/business-hours-rule`|\n\n---\n\n* custom Time Zone is now supported\n\n|Changed Methods|\n|-----------|\n|🔧 `POST /account/{accountId}/extension/{extensionId}/answering-rule`|\n|🔧 `PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n* IMS number in answering rules\n\n|Changed Methods|\n|-----------|\n| `GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n| `PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n### Meetings\n\n#### Meeting Configuration\n\n|New Methods|\n|-----------|\n|⭐ `POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting-configuration/profile-image`|\n\n---\n\n* new scheduling settings\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting/user-settings`|\n|`GET /account/{accountId}/meeting/locked-settings`|\n\n---\n\n* new 'ThirdParty' option for audio\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting/user-settings`|\n\n---\n\n### Account\n\n#### User Settings\n\n* new 'DelegatedLinesGroup' extension type supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}`|\n|`PUT /account/{accountId}/extension/{extensionId}`|\n\n---\n\n#### Bulk Update Extension\n\n|New Methods|\n|-----------|\n|⭐ `POST /restapi/v1.0/account/accountId/extension-bulk-update`|\n|⭐ `GET /restapi/v1.0/account/accountId/extension-bulk-update/tasks/taskId`|\n\n---\n\n### Provisioning\n\n#### Extensions\n\n* new 'DelegatedLinesGroup' extension type supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension`|\n\n---\n\n#### Video Configuration\n\n* new 'userLicenseType' supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/video-configuration`|\n|`PUT /account/{accountId}/extension/{extensionId}/video-configuration`|\n\n---\n\n### Address Book\n\n#### External Contacts\n\n##### Address Book Bulk Upload API\n\n|New Methods|\n|-----------|\n|⭐ `POST /account/{accountId}/address-book-bulk-upload`|\n|⭐ `GET /account/{accountId}/address-book-bulk-upload/tasks/{taskId}`|\n\n---\n\n* new 'ringtoneIndex' attribute supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/address-book/contact`|\n|`POST /account/{accountId}/extension/{extensionId}/address-book/contact`|\n|`PUT /account/{accountId}/extension/{extensionId}/address-book/contact`|\n|`GET /account/{accountId}/extension/{extensionId}/address-book/contact/{contactsId}`|\n|`PUT /account/{accountId}/extension/{extensionId}/address-book/contact/{contactsId}`|\n|`GET /account/{accountId}/extension/{extensionId}/address-book/contact/adress-book-sync`|\n\n---\n\n#### Internal Contacts\n\n* new 'DelegatedLinesGroup' extension type supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/accountId/directory/entries`|\n|`GET /account/accountId/directory/entries/{entryId}`|\n|`GET /account/accountId/directory/entries/search`|\n\n---\n\n### Events & Notifications\n\n#### Notification Types\n\n* `queueCall` flag is supported\n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/presence?detailedTelephonyState=true`]|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence?detailedTelephonyState=true`]|\n\n---\n\n"},{"title":"2020 Aug (20.3)","description":"*1.0.44*\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n---\n\n### Messaging\n\n#### Message Export\n\n* now only 2 parallel message report tasks are allowed\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n### Call Management \n\n#### Rule Management\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n|`GET /account/{accountId}/extension/{extensionId}/answering-rule`|\n|`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n|`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n##### Call Handling Rules Bugfixes\n\n* `BusinessMobileNumber` label supported\n\n|Changed Methods|\n|-----------|\n|🔧 `GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n|🔧 `PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n### Meetings\n\n#### Meeting Configuration\n\n|New Methods|\n|-----------|\n|⭐️ `GET /account/{accountId}/extension/{extensionId}/meeting/locked-settings`|\n\n---\n\n#### Meeting Management \n\n##### Create Meetings\n\n* `muteParticipantsOnEntry` supported\n* `enforceLogin` supported\n* `enableWaitingRoom` supported\n* `globalDialInCountries` supported\n\n\n|Changed Methods|\n|-----------|\n|`POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting`|\n\n---\n\n##### Update Meeting\n\n* `enforceLogin` supported\n* `muteParticipantsOnEntry` supported\n* `enableWaitingRoom` supported\n* `globalDialInCountries` supported\n\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting/{meetingId}`|\n|`PUT /account/{accountId}/extension/{extensionId}/meeting/{meetingId}`|\n\n---\n\n###### Meeting Invitation \n\n|New Methods|\n|-----------|\n|⭐️ `GET /account/{accountId}/extension/{extensionId}/meeting/{meetingId}/invitation`|\n\n---\n\n#### Meeting Recording\n\n##### Get Account Meeting Recordings List\n\n* `cfUri` supported\n* `filePath` supported\n\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting-recording`|\n\n---\n\n##### Get User Meeting Recordings List\n\n* `cfUri` supported\n* `filePath` supported\n\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting-recording`|\n\n---\n\n### Account \n\n#### Phone Numbers\n\n* `BusinessMobileNumber` usageType supported\n* `BusinessMobileNumberProvider` paymentType supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/{accountId}/phone-number`|\n\n---\n\n* `BusinessMobileNumber` usageType supported\n* `BusinessMobileNumberProvider` paymentType supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/phone-number`|\n\n---\n\n#### User Permissions\n\n* `domain` supported.\n\n|Changed Methods|\n|---------------|\n|`GET /restapi/v1.0/account/~/extension/~/authz-profile`|\n|`GET /restapi/v1.0/account/~/extension/~/authz-profile/check`|\n\n---\n\n#### User Settings\n\n* `ProxyAdmin` Extension type supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/extension/{extensionId}`|\n|`PUT /account/{accountId}/extension/{extensionId}`|\n\n---\n\n* Caller ID for Business Mobile device supported\n\n|Changed Methods|\n|---------------|\n|`GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id`|\n|`PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id`|\n\n---\n\n#### Extensions\n\n* `ProxyAdmin` Extension type supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/extension/{extensionId}`|\n\n---\n\n### Address Book\n\n#### Internal Contacts\n\n* search by `jobTitle` and `department` supported, `searchFields` introduced\n\n|Changed Methods|\n|-----------|\n|`POST /restapi/v1.0/account/~/directory/entries/search`|\n\n---\n\n\n"},{"title":"2020 May (20.2)","description":"*1.0.43*\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n---\n\n### Voice\n\n#### Call Control\n\n##### Warm Transfer supported\n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/telephony/{telephonySessionId}/parties/{partyId}/bridge`|\n\n##### Drop Party supported\n\n|Changed Methods|\n|-----------|\n|`DELETE /account/{accountId}/telephony/{telephonySessionId}/parties/{partyId}`|\n\n##### Answer Call Party\n\n* Call Queue calls supported\n\n|Changed Methods|\n|-----------|\n|`POST /account/{accountId}/telephony/{telephonySessionId}/parties/{partyId}/answer`|\n\n##### Transfer Call Party\n\n* Support extensionId in Transfer API\n\n|Changed Methods|\n|-----------|\n|`POST /account/{accountId}/telephony/{telephonySessionId}/parties/{partyId}/transfer`|\n\n---\n\n#### SIP\n\n* `emergency` and `device.phoneLines.id` supported\n\n|Changed Methods|\n|-----------|\n|`POST /client-info/sip-provision`|\n\n---\n\n### Call Management\n\n#### Rule Management\n\n##### Call Handling Rules Bugfixes\n\n* fixed a few scenarios when redundant forwarding phone numbers returned\n\n|Changed Methods|\n|-----------|\n|🔧 `GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n|🔧 `PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`|\n\n---\n\n### Meetings\n\n#### Meeting Configuration\n\n##### User Settings in Meetings API\n\n|New Methods|\n|-----------|\n|⭐️ `GET /account/{accountId}/extension/{extensionId}/meeting/user-settings`|\n\n---\n\n* 'usePMIForInstantMeetings' supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/meeting/service-info`|\n\n---\n\n### Account\n\n#### Company\n\n##### Contracted Country changes\n\n* 'contractedCountry' supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}`|\n|`GET /account/{accountId}/service-info`|\n\n---\n\n* 'currency' supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}`|\n\n---\n\n* 'freemiumProductType' supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}`|\n|`GET /account/{accountId}/service-info`|\n\n---\n\n#### Features\n\n##### New Features \n\n* 'EditEmailNotificationAppearance' feature supported\n* 'primaryApp' parameter\n* 'EmergencyCallNotification' feature supported \n\n|New Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/features`|\n\n---\n\n#### User Settings\n\n* `emailRecipients` supported\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/extension/{extensionId}/notification-settings`|\n|`PUT /account/{accountId}/extension/{extensionId}/notification-settings`|\n\n---\n\n#### Phone Numbers\n\n* 'A2PSMSSender' feature supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/phone-number`|\n\n---\n\n* 'ELIN' usageType supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/extension/{extensionId}/phone-number`|\n\n---\n\n### Provisioning\n\n#### Automatic Location Updates\n\n##### Emergency Locations changes\n\n* Application permission for Emergency Location List API changed from EditAccountInfo to ReadAccountInfo\n\n|Changed Methods|\n|-----------|\n|`GET /account/{accountId}/emergency-locations`|\n\n--- \n#### Devices\n\n##### Emergency support in Devices API\n\n* `emergency` supported.\n\n|Changed Methods|\n|---------------|\n|[`PUT /account/{accountId}/device/{deviceId}`]\n\n---\n\n### Events & Notification\n\n#### Notification Types\n\n* new 'AnsweringRules' hint supported\n* filter by hint is now supported for Extension List & Extension Info subscription\n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/extension`](/Extension-List-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}`](/Extension-Info-EventEvent)|\n\n---\n\n##### Emergency Address change notifications\n\n* new event filter supported\n\n|Changed Event Filters|\n|---------------------|\n|⭐ [`/restapi/v1.0/account/{accountId}/device/{dedviceId/emergency-address}`]|\n\n--- \n\n##### CCRN phone number change notifications\n\n* new event filter supported\n\n|Changed Event Filters|\n|---------------------|\n|⭐ [`/restapi/v1.0/account/{accountId}/phone-number?usageType=ContactCenterNumber`]|\n\n--- \n\n\n"},{"title":"2020 Feb (20.1)","description":"*1.0.42*\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Glip\n\n#### Notes\n\n* increased limit \n\n|Changed Methods|\n|---------------|\n|[`POST /glip/chats/chatId/notes`]|\n|[`PATCH /glip/chats/chatId/notes/{noteId}`]|\n\n#### Glip Compliance Exports\n\n* 'Expired' status supported\n* 'Canceled' status change\n\n|Changed Methods|\n|---------------|\n|[`GET /glip/data-export`]|\n|[`GET /glip/data-export/{taskId}`]|\n\n---\n\n### Call Management\n\n#### Call Routing\n\n##### Sites supported for IVR Menus\n* 'site' is supported in IVR Menus APIs\n\n|Changed Methods|\n|---------------|\n|[`POST account/{accountId}/ivr-menus`](/Call-Routing/createIVRPrompt)|\n|[`PUT account/{accountId}/ivr-menus/{ivrMenuId}`](/Call-Routing/updateIVRPrompt)|\n|[`GET account/{accountId}/ivr-menus/{ivrMenuId}`](/Call-Routing/readIVRPrompt)|\n\n---\n\n### Meetings\n\n#### Meeting Configuration\n\n##### Meeting Features\n\n|New Methods|\n|-----------|\n|⭐️ `GET /account/{accountId}/meeting-features`|\n---\n\n#### Meeting Management\n\n* new `meetingType` attribute supported for recurrent meetings.\n\n|Changed Methods|\n|-----------|\n|`POST /account/{accountId}/extension/{extensionId/meeting`|\n|`GET /account/{accountId}/extension/{extensionId/meeting`|\n|`GET /account/{accountId}/extension/{extensionId/meeting/{meetingId}`|\n|`PUT /account/{accountId}/extension/{extensionId/meeting/{meetingId}`|\n\n* new 'autoRecordType' supported\n\n|Changed Methods|\n|-----------|\n|`POST /account/{accountId}/extension/{extensionId/meeting`|\n\n---\n\n### Autentification\n\n* 🔧 OAU-164 - new error code for invalid client app is used for token revocation case\n* 🔧 OAU-165 - new error code for sandbox client app is not allowed case\n\n---\n\n### Account\n\n#### Company\n\n##### Custom Fields \n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/custom-fields`|\n|⭐️ `GET /account/{accountId}/custom-fields`|\n|⭐️ `PUT /account/{accountId}/custom-fields/{fieldId}`|\n|⭐️ `DELETE /account/{accountId}/custom-fields/{fieldId}`|\n\n---\n\n#### Features\n\n##### Account Limits and Federation Flag\n\n* new feature flag `FederatedAccount` supported\n* new feature params FreeSoftPhones: limitMax, InternalCalling: extensionNumberLengthMax, SiteCodes: siteCodeLength, SiteCodes: shortExtensionNumberLength supported.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/features`](/Features/readUserFeatures)|\n\n##### Emergency Locations\n\n* new feature flags `ReadEmergencyLocations`, `EditEmergencyLocations`, `ReadExtensionEmergencyLocations` supported\n\n#### User Permissions\n\n##### Emergency Locations\n\n* new permissions `ReadEmergencyLocations`, `EditEmergencyLocations` supported\n\n#### User Settings\n\n##### Custom Fields \n* new attribute `customFields.id` supported.\n* new attribute `customFields.value` supported.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}`](/User-Settings/readExtension)|\n|[`PUT /account/{accountId}/extension/{extensionId}`](/User-Settings/updateExtension)|\n\n---\n\n### Provisioning\n\n#### Automatic Location Updates\n\n##### Emergency Locations change\n\n* User emergency location list supported \n* Emergency Response Locations changes\n* `validateOnly` query parameter supported\n\n|New Methods|\n|-----------|\n|⭐ `GET /account/{accountId}/extension/{extensionId}/emergency-locations`|\n\n|Changed Methods|\n|-----------|\n|`GET /account/~/emergency-locations`|\n|`POST /account/~/emergency-locations`|\n|`GET /account/~/emergency-locations/{locationId}`|\n|`DELETE /account/~/emergency-locations/{locationId}`|\n\n#### Devices\n\n##### Emergency Locations changes\n\n* `emergency` supported\n\n|Changed Methods|\n|-----------|\n|`GET /account/~/device/{deviceId}`|\n|`PUT /account/~/device/{deviceId}`|\n|`GET /account/~/extension/{extensionId}/device`|\n\n##### Custom Fields\n* new attribute `customFields.id` supported.\n* new attribute `customFields.value` supported.\n\n|Changed Methods|\n|---------------|\n|[`POST /account/{accountId}/extension`](/Extensions/createExtension)|\n\n---\n\n### Events & Notifications\n\n#### Notification Types\n* new \"VideoConfiguration\" hint supported\n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/extension`](/Extension-List-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}`](/Extension-Info-EventEvent)|\n\n##### Presence Notifications for Not Activated Users\n\n* Added ability to monitor presence of non-activated Users. \n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/presence`](/Account-Extension-Presence-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence`](/Extension-Presence-Event)|\n\n##### Queue Calls Display Info in Presence API\n\n* `callInfo` attribute added to notification payload.\n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/presence`](/ExtAccount-Extension-Presence-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence`](/Extension-Presence-Event)|\n\n---\n\n##### Support \"missedCall\" query parameter for telephony/sessions subscriptions\n\n* Ability to subscribe on Telephony Sessions notifications where \"missedCall\" flag is explicitly set to \"true\". \n\n|Changed Event Filters|\n|---------------------|\n|[`/restapi/v1.0/account/{accountId}/telephony/sessions?missedCall=true`](/Account-Telephony-Sessiona-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions?missedCall=true`](/Extension-Telephony-Sessiona-Event)|\n\n---\n\n"},{"title":"2019 Dec","description":"\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Account\n\n#### Features\n\n##### Room Connector\n\n* new feature flag `EditRoomConnector` supported.\n\n|Changed Methods|\n|---------------|\n|[`GET account/{accountId}/extension/{extensionId}/features`](/Features/readUserFeatures)|\n\n---\n\n#### Phone Numbers\n\n##### ⚠ Toll Free SMS Sender Phone Number Feature Removal\n\n* `TollFreeSmsSender` value not supported anymore for `features` attribute.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/phone-number`](/Phone-Numbers/listExtensionPhoneNumbers)|\n\n### Voice\n\n#### Call Control\n\n##### ⭐ Call Monitoring: Party Supervise\n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/supervise`|\n---\n\n##### Call Session Status\n\n* new 'parties.accountId' and 'parties.extensionId' attributes supported.\n* existing 'parties.owner.accountId' and 'parties.owner.extensionId' are deprecated\n\n|Changed Methods|\n|-----------|\n|️ `GET /account/{accountId}/telephony/sessions/{sessionId}`|\n|️ `GET /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}`|\n\n---\n\n"},{"title":"2019 Nov","description":"*1.0.41*\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Account\n\n#### Phone Numbers\n\n##### Status Filter\n\n* new `status` query parameter is supported.\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/phone-number`|\n|`GET /account/{accountId}/extension/{extensionId}/phone-number`|\n\n#### User Settings\n\n##### Call Queue Manager Grants\n\n* new `extensionType` query parameter supported;\n* new `callQueueSetup`, `callQueueMembersSetup`, `extension.name` response attributes added.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/grant`](\"#User-Settings-listExtensionGrants\")|\n\n----\n\n### Authentication\n\n##### ⚠️ Tokens\n\n* new error code:`OAU-163` introduced: \"Login of this call queue is not allowed as queue managers are selected from the user list.\"\n\n|Changed Methods|\n|---------------|\n|[`POST /restapi/oauth/token`](#Get-Token)|\n\n----\n\n### Call Management\n\n#### Call Routing\n\n##### IVR Prompt Size\n\n* max IVR prompt size increased to 20Mb.\n\n|Changed Methods|\n|---------------|\n|🔐 [`POST /account/{accountId}/ivr-prompts`](#Call-Routing-createIVRPrompt)\n\n#### Rule Management\n##### ⚠️ Shared Line Group Call Handling Rules\n\n* new `SharedLines` value supported for `callHandlingAction` attribute.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/answering-rule`](#Rule-Management-createAnsweringRule)|\n|[`POST /account/{accountId}/extension/{extensionId}/answering-rule`](#Rule-Management-listAnsweringRules)|\n|[`GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-readAnsweringRule)|\n|[`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-updateAnsweringRule)|\n\n##### Shared Line Group Hold Music\n\n* `HoldMusic` value supported for greeting `type` attribute;\n* `HoldMusic` value supported for `greetings[].type` attribute.\n\n|Changed Methods|\n|---------------|\n|[`POST /account/{accountId}/extension/{extensionId}/greeting`](Rule-Management/createCustomUserGreeting)|\n|[`GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](Rule-Management/readAnsweringRule)|\n\n----\n\n### Events & Notifications\n\n#### Extension Change Event\n##### ⚠️ New Hints\n\n* new values `AccountSettings`, `AccountStatus`, `CompanyNumbers`, `Features`, `Limits`, `Permissions` supported for `hints` attibute in notification payload;\n* values `AccountInfo`, `PhoneNumber`, `Role` suppressed.\n\n|Changed Notification Payloads|\n|-----------------------------|\n|`/restapi/v1.0/account/{accountId}/extension/{extensionId}`|\n\n----\n\n### Meetings\n\n#### Meeting Configuration\n\n##### ⭐️ Personal Meeting ID\n\n|New Methods|\n|-----------|\n|⭐️ `PATCH /account/{accountId}/extension/{extensionId}/meeting/service-info`|\n\n---\n\n### Messaging\n\n#### Fax\n\n##### Fax Size Limit Increased\n\n* Max attachment size limit (each/total) increased to 50Mb.\n\n|Changed Methods|\n|---------------|\n|[`POST /account/{accountId}/extension/{extensionId}/fax`](Fax/createFaxMessage)|\n\n### Provisioning\n\n#### Devices\n##### Country/State ID in Request\n\n* `countryId` and `stateId` request attributes supported.\n\n|Changed Methods|\n|---------------|\n|🔐 [`PUT /account/{accountId}/device/{deviceId}`](#Devices-updateDevice)]\n\n##### Emergency Address for Shared Line Group Devices\n\n* address updating supported for SLG devices.\n\n|Changed Methods|\n|---------------|\n|🔐 [`PUT /account/{accountId}/device/{deviceId}`](#Devices-updateDevice)]\n\n----\n\n### Voice\n\n#### Call Control\n\n##### ⚠️ Call Out Origin\n\n* new value `CallOut` supported for `origin.type` attribute.\n\n|Changed Methods|\n|---------------|\n|[`POST /account/{accountId}/telephony/call-out`](Call-Control/createCallOutCallSession)|\n|[`GET /account/{accountId}/telephony/sessions/{sessionId}`](Call-Control/readCallSessionStatus)|\n\n#### Call Log\n\n##### Short Recording Indicator\n\n* `[records.]shortRecording` and `[records.]legs.shortRecording` attributes added. \n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/call-log[/{recordId}]`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log/[{recordId}]`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log-sync`|\n\n##### 🔧 Sync Recording Filter Fix\n\n* issue with incorrect behavior of `withRecording` filter (returning calls without recording in some cases) fixed.\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/extension/{extensionId}/call-log-sync`|\n\n##### Telephony Session ID\n\n* `telephonySessionId` attribute added.\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/call-log`|\n|`GET /account/{accountId}/call-log/{callRecordId}`|\n|`GET /account/{accountId}/call-log-sync`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log/{callRecordId}`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log-sync`|\n|`GET /account/accountId/active-calls`|\n|`GET /account/{accountId}/extension/{extensionId}/active-calls`|\n\n---\n\n"},{"title":"2019 Oct","description":"\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Messaging\n\n#### Message Exports\n##### ⚠️ Phone Number Masking\n\n* `from.phoneNumber` and `to.phoneNumber` attribute values may be returned with last four digits masked in certain conditions, e.g. `+3351234XXXX`.\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/message-store-report/{taskId}/archive/{archiveId}`|\n\n----\n\n### Voice\n\n#### Call Log\n\n##### ⚠️ Phone Number Masking\n\n* `phoneNumber` attribute value may be returned with last four digits masked in certain conditions, e.g. `+3351234XXXX`.\n\n|Changed Methods|\n|---------------|\n|`GET /account/{accountId}/call-log`|\n|`GET /account/{accountId}/call-log/{callRecordId}`|\n|`GET /account/{accountId}/call-log-sync`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log/{callRecordId}`|\n|`GET /account/{accountId}/extension/{extensionId}/call-log-sync`|\n|`GET /account/accountId/active-calls`|\n|`GET /account/{accountId}/extension/{extensionId}/active-calls`|\n\n---\n\n"},{"title":"2019 Sep","description":"\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Authentication\n\n##### HS256 Signed Tokens Restriction\n\n* new error code `OAU-347` introduced: \"An algorithm which is used for assertion signing is not supported for JWT Bearer grant type\".\n\n|Changed Methods|\n|---------------|\n|[`POST /restapi/oauth/token`](#Get-Token)|\n\n---\n\n"},{"title":"2019 Aug","description":"*1.0.40*\n\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Account\n\n#### Phone Numbers\n\n##### Temporary Numbers\n\n* `temporaryNumber` attribute added.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{id}/phone-number`](#Phone-Numbers-listAccountPhoneNumbers)|\n|[`GET /account/{id}/phone-number/{numberId}`](#Phone-Numbers-readAccountPhoneNumber)|\n\n#### User Settings\n\n##### Conferencing Premium Numbers\n\n* `phoneNumbers.premium` attribute added.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/conferencing`](#User-Settings-readConferencingSettings)|\n|[`PUT /account/{accountId}/extension/{extensionId}/conferencing`](#User-Settings-updateConferencingSettings)|\n\n---\n\n### Call Management\n\n#### Rule Management\n\n##### 🔧 Call Queue Max Callers Limit\n\n* `queue.maxCallers` max value decreased to 25.\n\n|Changed Methods|\n|---------------|\n|[`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-updateAnsweringRule)|\n\n##### 🔧 Call Queue Wrap-up Time Limit\n\n* `queue.wrapUpTime` max value increased to 300.\n\n|Changed Methods|\n|---------------|\n|[`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-updateAnsweringRule)|\n\n##### Music on Hold for Limited Extensions\n\n* `HoldMusic` greeting type supported for extensions of `Limited` type.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/answering-rule`](#Rule-Management-createAnsweringRule)|\n|[`POST /account/{accountId}/extension/{extensionId}/answering-rule`](#Rule-Management-listAnsweringRules)|\n|[`GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-readAnsweringRule)|\n|[`PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}`](#Rule-Management-updateAnsweringRule)|\n\n---\n\n### Events & Notifications\n\n#### Reply with Text Reason\n\n* `parties.state.reason` attribute added to notification payload.\n\n|Changed Notification Payloads|\n|-----------------------------|\n|[`/restapi/v1.0/account/{accountId}/telephony/sessions`](#Account-Telephony-Sessions-Event)|\n|[`/restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions`](#Extension-Telephony-Sessions-Event)|\n\n### Messaging\n\n#### Fax\n\n##### ⭐️ Fax Cover Page Settings\n\n|New Methods|\n|-----------|\n|⭐️ `GET /account/{accountId}/extension/{extensionId}/fax-cover-page`|\n|⭐️ `PUT /account/{accountId}/extension/{extensionId}/fax-cover-page`|\n\n##### ⚠️ New Error Codes\n\n* `WrongNumber` and `AllLinesInUse` values supported for `records[].to[].faxErrorCode` attribute.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/extension/{extensionId}/message-store`](#Fax-listMessages)|\n|[`GET /account/{accountId}/extension/{extensionId}/message-sync`](#Fax-syncMessages)|\n\n#### Message Store\n\n##### 🔧 Message Deletion\n\n* if the message is already deleted, `HTTP 204` returned instead of `HTTP 404`.\n\n|Changed Methods|\n|---------------|\n|[`DELETE /account/{accountId}/extension/{extensionId}/message-store/{messageId}`](#Message-Store-deleteMessage)|\n\n#### ⭐️ MMS\n\n* dedicated `mms` endpoint supported.\n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/extension/{extensionId}/mms`|\n\n---\n\n### Provisioning\n\n#### Automatic Location Updates\n\n##### ⭐️ 🔐 Emergency Response Locations\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 `GET /account/{accountId}/emergency-locations`|\n|⭐️ 🔐 `POST /account/{accountId}/emergency-locations`|\n|⭐️ 🔐 `GET /account/{accountId}/emergency-locations/{locationId}`|\n|⭐️ 🔐 `PUT /account/{accountId}/emergency-locations/{locationId}`|\n|⭐️ 🔐 `DELETE /account/{accountId}/emergency-locations/{locationId}`|\n\n##### 🔐 Emergency Response Locations Applying\n\n* `emergencyLocationId` parameter supported.\n\n|Changed Methods|\n|---------------|\n|🔐 [`POST account/{accountId}/emergency-address-auto-update/networks`](#Emergency-Address-Settings-postEmergencyAddressAutoUpdateNetwork)|\n|🔐 [`PUT account/{accountId}/emergency-address-auto-update/networks/{networkId}`](#Emergency-Address-Settings-updateEmergencyAddressAutoUpdateNetwork)|\n|🔐 [`GET account/{accountId}/emergency-address-auto-update/networks`](#Emergency-Address-Settings-getEmergencyAddressAutoUpdateNetworks)|\n|🔐 [`GET account/{accountId}/emergency-address-auto-update/networks/{networkId}`](#Emergency-Address-Settings-getEmergencyAddressAutoUpdateNetwork)|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/switches`|\n|🔐 `PUT /account/{accountId}/emergency-address-auto-update/switches/{switchId}`|\n|🔐 `GET /account/{accountId}/emergency-address-auto-update/switches`|\n|🔐 `GET /account/{accountId}/emergency-address-auto-update/switches/{switchId}`|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/switches-bulk-create`|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/switches-bulk-update`|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/switches-bulk-validate`|\n|🔐 [`POST account/{accountId}/emergency-address-auto-update/wireless-points`](#Emergency-Address-Settings-createEmergencyAddressAutoUpdateWirelessPoint)|\n|🔐 [`PUT account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}`](#Emergency-Address-Settings-emergencyAddressAutoUpdateWirelessPointUpdate)|\n|🔐 [`GET account/{accountId}/emergency-address-auto-update/wireless-points`](#Emergency-Address-Settings-getEmergencyAddressAutoUpdateWirelessPoints)|\n|🔐 [`GET account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}`](#Emergency-Address-Settings-getEmergencyAddressAutoUpdateWirelessPoint)|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create`|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update`|\n|🔐 `POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate`|\n\n##### 🔐 User Filtering by Entitlement\n\n* only users with appropriate Hard Phone / SoftPhone entitlements returned and can have automatic location updates on.\n\n|Changed Methods|\n|---------------|\n|🔐 [`GET /account/{accountId}/emergency-address-auto-update/users`](#Automatic-Location-Updates-listAutomaticLocationUpdatesUsers)|\n|🔐 [`POST /account/{accountId}/emergency-address-auto-update/users/bulk-assign`](#Automatic-Location-Updates-assignMultipleAutomaticaLocationUpdatesUsers)|\n\n---\n\n### Voice\n\n#### Call Control\n\n##### ⭐️ Answering the Call\n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/answer`|\n\n##### ⭐️ Parked Call Pickup\n\n|New Methods|\n|-----------|\n|⭐️ `POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/pickup`|\n\n##### ⚠️ Reply with Text Reason\n\n* `parties.state.reason` attribute added.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/telephony/sessions/{telephonySessionId}`](#Call-Control-readCallSessionStatus)|\n|[`GET /account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}`](#Call-Control-readCallPartyStatus)|\n\n##### ⚠️ Supervise Attributes Renaming\n\n* `agentExtensionNumber`, `agentExtensionId`, `supervisorDeviceId` attributes added in replacement of `extensionNumber` and `deviceId` (for backward complatibility reasons old ones still supported but deprecated).\n\n|Changed Methods|\n|---------------|\n|[POST /account/{accountId}/telephony/sessions/{sessionId}/supervise](#Call-Control-superviseCallSession)|\n\n#### Call Log\n\n##### ⚠️ Monitoring Action\n\n* `Monitoring` value supported for `action` attribute.\n\n|Changed Methods|\n|---------------|\n|[`GET /account/{accountId}/call-log`](#Call-Log-loadCompanyCallLog)|\n|[`GET /account/{accountId}/call-log/{callRecordId}`](#Call-Log-loadCompanyCallRecord)|\n|[`GET /account/{accountId}/extension/{extensionId}/call-log`](#Call-Log-loadUserCallLog)|\n|[`GET /account/{accountId}/extension/{extensionId}/call-log/{callRecordId}`](#Call-Log-getUserCallRecord)|\n|[`GET /account/{accountId}/extension/{extensionId}/call-log-sync`](#Call-Log-syncUserCallLog)|\n\n---\n\n\n"},{"title":"2019 Jul","description":"\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Glip\n\n#### ⭐️ Tasks\n\n|New Methods|\n|-----------|\n|⭐️ `GET /glip/chats/{chatId}/tasks`|\n|⭐️ `POST /glip/chats/{chatId}/tasks`|\n|⭐️ `GET /glip/tasks/{taskId}`|\n|⭐️ `PUT /glip/tasks/{taskId}`|\n\n"},{"title":"2019 Jun","description":"\n🔐 – **advanced** – API available by request, if you want to use it, please welcome to [Support page](https://developers.ringcentral.com/support.html).\n\n⚠️ – please pay attention to this change as it may potentially break compatibility with your app.\n\n⭐️ – new API methods introduced.\n\n🔧 – bug fixes.\n\n\nBasepath for all URLs: `https://platform.ringcentral.com/restapi/v1.0`.\n\n### Provisioning\n\n#### Automatic Location Updates\n\n##### ⭐️ Bulk Operations\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/switches-bulk-create`](#Automatic-Location-Updates-createMultipleSwitches)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/switches-bulk-update`](#Automatic-Location-Updates-updateMultipleSwitches)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/switches-bulk-validate`](#Automatic-Location-Updates-validateMultipleSwitches)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create`](#Automatic-Location-Updates-createMultipleWirelessPoints)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update`](#Automatic-Location-Updates-updateMultipleWirelessPoints)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate`](#Automatic-Location-Updates-validateMultipleWirelessPoints)|\n\n##### ⭐️ Devices\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`GET /account/{accountId}/emergency-address-auto-update/devices`](#Automatic-Location-Updates-listDevicesAutomaticLocationUpdates)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/devices/bulk-assign`](#Automatic-Location-Updates-assignMultipleDevicesAutomaticLocationUpdates)|\n\n##### ⭐️ Extensions\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`GET /account/{accountId}/emergency-address-auto-update/users`](#Automatic-Location-Updates-readAutomaticLocationUpdatesUsers)|\n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/users/bulk-assign`](#Automatic-Location-Updates-assignMultipleUsersAutomaticaLocationUpdates)|\n|\n\n##### ⭐️ IP Address Range Map\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`GET account/{accountId}/emergency-address-auto-update/networks`](#Automatic-Location-Updates-listNetworks)|\n|⭐️ 🔐 [`POST account/{accountId}/emergency-address-auto-update/networks`](#Automatic-Location-Updates-createNetwork)|\n|⭐️ 🔐 [`GET account/{accountId}/emergency-address-auto-update/networks/{networkId}`](#Automatic-Location-Updates-readNetwork)|\n|⭐️ 🔐 [`PUT account/{accountId}/emergency-address-auto-update/networks/{networkId}`](#Automatic-Location-Updates-updateNetwork)|\n|⭐️ 🔐 [`DELETE account/{accountId}/emergency-address-auto-update/networks/{networkId}`](#Automatic-Location-Updates-deleteEmergencyAddressAutoUpdateNetwork)|\n\n##### ⭐️ Switch Map\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`GET /account/{accountId}/emergency-address-auto-update/switches`](#Automatic-Location-Updates-listAccountSwitches)| \n|⭐️ 🔐 [`POST /account/{accountId}/emergency-address-auto-update/switches`](#Automatic-Location-Updates-createSwitch)|\n|⭐️ 🔐 [`GET /account/{accountId}/emergency-address-auto-update/switches/{switchId}`](#Automatic-Location-Updates-readSwitch)|\n|⭐️ 🔐 [`PUT /account/{accountId}/emergency-address-auto-update/switches/{switchId}`](#Automatic-Location-Updates-updateSwitch)|\n|⭐️ 🔐 [`DELETE /account/{accountId}/emergency-address-auto-update/switches/{switchId}`](#Automatic-Location-Updates-deleteSwitch)|\n\n##### ⭐️ Wireless Access Point Map\n\n|New Methods|\n|-----------|\n|⭐️ 🔐 [`GET account/{accountId}/emergency-address-auto-update/wireless-points`](#Automatic-Location-Updates-listWirelessPoints)|\n|⭐️ 🔐 [`POST account/{accountId}/emergency-address-auto-update/wireless-points`](#Automatic-Location-Updates-createWirelessPoint)|\n|⭐️ 🔐 [`GET account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}`](#Automatic-Location-Updates-readWirelessPoint)|\n|⭐️ 🔐 [`PUT account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}`](#Automatic-Location-Updates-updateWirelessPoint)|\n|⭐️ 🔐 [`DELETE account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}`](#Automatic-Location-Updates-deleteWirelessPoint)|\n\n---\n\n"},{"title":"Older Versions","description":"\nFor older versions, see RingCentral API Changelog on [ReadTheDocs](https://ringcentral-api-changelog.readthedocs.io/en/latest/1_0_37/)\n"}]},{"title":"Data Formats","x-tag-group":"Using the API","description":"\n","children":[{"title":"Object Representation","description":"Whenever you need to send or retrieve a particular piece of data — for example, a call log record, information on an extension, etc. — it will be embedded in the HTTP request or response.\n\nThe RingCentral API allows you to explicitly define a representation format by using the following HTTP headers.\n\n- `Content-Type` header defines the MIME type of the request body. The server will expect the request body to contain data in the specified format.\n- `Accept` header indicates desired MIME type of the response body. The server will return response data in this format (if possible) and will set the `Content-Type` response header accordingly.\n\n### Supported Representation Formats\n| Format | MIME type | HTTP request/response body example |\n| ------ | --------- | ---------------------------------- |\n| JSON | `application/json` |
`{`
  `\"uri\": \"https://platform.ringcentral.com/restapi/v1.0\",`
  `\"versionString\": \"1.0.0\",`
  `\"releaseDate\": \"2012-06-14T00:00:00.000Z\",`
  `\"uriString\": \"v1.0\",`
`}`
|\n| HTML Form Data *(only for token request body as governed by OAuth 2.0 specification)* | `application/x-www-form-urlencoded` | `grant_type=password&username=18887776655&password=987654` |\n\nThe RingCentral API uses JSON as the default representation format. It means that if the `Accept` header is not set, the server will return results in JSON. \n\nHowever, `Content-Type` header is mandatory for all requests which have body (namely requests with `POST` and `PUT` HTTP methods). Also for such requests client is required to provide `Content-Length` header containing the length of the request body in bytes.\n\n"},{"title":"Data Types","description":"The table below describes the data types which are used in the RingCentral API.\n\n| Data Type | Description |\n| ------------- | ----------- |\n| `string` | General string value |\n| `enumeration` | Predefined string constants/List of predefined string constants |\n| `integer` | 64-bit integer value |\n| `datetime` | Timestamp in XML schema-compatible format, in accordance with ISO 8601 format including timezone.

Note that **T** appears literally in the string, to indicate the beginning of the time element.

The supported formats with the examples are as follows:

Year: `YYYY` (eg 2012)

Year and month: `YYYY-MM` (eg 2012-07)

Complete date: `YYYY-MM-DD` (eg 2012-07-16)

Complete date plus hours and minutes: `YYYY-MM-DDThh:mmTZD` (eg 2012-07-16T23:12:30)

Complete date plus hours, minutes and seconds:

`YYYY-MM-DDThh:mm:ssTZD` (eg 2012-07-16T23:12:30Z or 2012-07-16T23:12:30+04:00)

Complete date plus hours, minutes, seconds and a decimal fraction of a second: 
YYYY-MM-DDThh:mm:ss.sTZD (eg 2012-07-16T23:12:30.45Z)


**Where:**

`YYYY` = four-digit year
`MM` = two-digit month (01=January, etc.)
`DD` = two-digit day of month (01 through 31)
`hh` = two digits of hour (00 through 23) (am/pm NOT allowed)
`mm` = two digits of minute (00 through 59)
`ss` = two digits of second (00 through 59)
`s` = one or more digits representing a decimal fraction of a second
`TZD` = time zone designator (Z or +hh:mm or -hh:mm)

The server currently processes all timestamps in UTC timezone; for example, 2012-01-01T00:15:34Z.

By default the server returns datetime format in full format, including a decimal fraction of a second YYYY-MM-DDThh:mm:ss.sTZD, for example 2012-07-16T23:12:30.45Z).

Please note, that when comparing timestamps, the timestamp is truncated to a second precision. For example, the response to request where the **dateFrom** value equals to 2012-07-16T23:12:30.45Z is always identical to the one with the 'dateFrom' value 2012-07-16T23:12:30Z.\n\n"},{"title":"Phone Numbers","description":"\nThe API supports phone numbers in [e.164](https://en.wikipedia.org/wiki/E.164) format with plus sign `+` complying with the [ITU-T recommendation](https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-11-2011-PDF-E.pdf).\n```json \n\"from\" : \n {\n \"phoneNumber\" : \"+16501234567\",\n \"name\" : \"John Smith\"\n }\n```\n\nThe phone number processing also conforms to country specific compliance requirements, such as the California Consumer Privacy Act (US), the General Data Protection Regulation (EU), etc. relating to personal data protection, e.g. masking numbers in call log API, that looks as follows:\n\n```json \n\"to\" : \n {\n \"phoneNumber\" : \"+1855201XXXX\",\n \"name\" : \"Jane Williams\" \n }\n```\n"},{"title":"Resource Identification","description":"The table below describes properties which are supported by almost all API resources and used for identification purposes.\n\n| Parameter | Type | Description |\n| --------- | ---------- | ----------- |\n| `id` | string | Internal unique identifier of a resource. This property exists in all resources which support retrieval/update/delete of a single record of particular type. Depending on a resource it can hold either an integer or a string value. The resource ID is also passed as a path parameter in the URI |\n| `uri` | URI string | Canonical URI of a resource. This URI might not be the same as the one which was used to retrieve this resource information. For example, if a resource was accessed by the URI containing simplified syntax with the tilde (~) characters, the canonical URI will also contain real identifiers. In most cases the URI contains an ID value embedded as a path parameter |\n\nThe similar convention is used when one resource refers to another. For example, a direct phone number returned by the API contains a link to the extension it is assigned to in the following property:\n\n```json\n\"extension\":\n {\n \"id\": 234244008,\n \"uri\": \".../account/405884008/extension/234244008\"\n }\n```\n\n"},{"title":"Response Format","description":"\nSince REST API is built on top of HTTP protocol, it reuses some concepts and common HTTP status codes to inform a client about a result of API method execution.\n\nThere could be the following possible response scenarios\n\n* **Successful** completion of a request. The client gets HTTP response with 2XX or 3XX status code and optionally somebody payload depending on the request. \n* **Client errors**. The server returns HTTP response with one of the 4xx status code. In most cases, the response body contains more detailed information about the reason for the issue. Such error usually means that the client does something wrong, unexpected or disallowed.\n* **Server errors**. The server returns HTTP response with one of the 5xx status code. In most cases, the response body contains more detailed information about the reason for the issue. This kind of errors is returned in case of unexpected issues on the server side.\n* This guideline follows general patterns described here: http://www.restapitutorial.com/httpstatuscodes.html\n\n### API Response Status Codes\n#### HTTP 2xx – Success\nMost of the HTTP 2xx status codes (200, 201, 202, 204, 206) indicate that the action requested by the client was received, understood, accepted and processed successfully.\n\n`HTTP 207 Multi-status` code can be returned for some API requests which means that response consists of multiple parts returned as a \"multipart/mixed\" body (see also [RFC 2046](https://tools.ietf.org/html/rfc2046)). In this case, the first part of this multipart response contains JSON array with real status codes corresponding to each part of a response, see [Batch Requests](#Batch-Requests) section below.\n\n#### HTTP 3xx – Redirection\nThis class of status code indicates the client must take additional action to complete the request. Many of these status codes are used in redirection.\n\nFor `HTTP 301`, `HTTP 302`, `HTTP 303`, `HTTP 307` and `HTTP 308` client must support automatic redirection to new URL returned in Location header as specified in [RFC 2616](http://tools.ietf.org/html/rfc2616#section-10.3)\n\nIf by some reason `Location` header is not returned, the client should repeat request to the same URL.\n\n`HTTP 304` – can be returned only for some API requests which allow specifying conditional headers `If-None-Match`, `If-Modified-Since` (see also [RFC 7232](https://tools.ietf.org/html/rfc7232#page-13)). Such status is an indication that resource is not modified and the client doesn't need to update locally cached version of a resource.\n\nAPI clients have to follow the following rules when processing HTTP 3xx responses:\n* `HTTP 301`, `HTTP 302`, `HTTP 303` — request to target URL specified in Location header must be performed with `HEAD` method (if original method was `HEAD`) or `GET` method (if original method was `GET`, `PUT`, `POST` or `DELETE`)\n* `HTTP 307`, `HTTP 308` — request to target URL specified in `Location` header must be performed with the same HTTP method as the original request\n* `HTTP 304` – no additional requests to the server should be performed.\n\n#### HTTP 4xx – Client Error\nThe 4xx class of status code is intended for cases in which the client seems to have erred. In most cases (except `HTTP 429`) request should **not** be retried in unchanged form. RingCentral API can return `HTTP 400`, `HTTP 403`, `HTTP 405`, `HTTP 406`, `HTTP 408`, `HTTP 409`, `HTTP 415` and other statuses which should be handled this way.\n\n##### HTTP 429 – Too Many Requests\nThis means that the client exceeded some quota or rate limit defined for all or for certain types of API requests. \nThe client may retry the original request after getting this HTTP code not earlier than in a number of seconds returned in `Retry-After` header (see [RFC 6585](https://tools.ietf.org/html/rfc6585#section-4)).\n\nAdditional information about throttling limits is returned in `X-RateLimit-XXX` response headers, see [Usage Plan Groups](#Usage-Plan-Groups).\n\n##### HTTP 401 – Unauthorized\nIt means that access token provided by a client is invalid or expired. The client should request new access token and repeat the request with it. Depending on used OAuth grant type and application settings the client may have refresh token (which should be used in this situation to get new access token). In case of client credentials, implicit and some other flows the client should repeat the original method to request a fresh access token.\n\n##### HTTP 404 – Not Found\nThis status code may mean that particular URL requested is invalid, or that resource with given ID (indicated as a part of URL) does not exist or not accessible for the authorized user.\nSuch error can be usually ignored if returned as a result of `DELETE` request which means that resource was already deleted on the server (which may happen due to different server-side retention policies or concurrent requests from other API clients).\n\n#### HTTP 5xx – Server Error\nThe server failed to fulfill an apparently valid request. The server is aware that it has encountered an error or is otherwise incapable of performing the request.\nThere can be very different reasons for the 50x status returned. The app should retry request up to 3 times, and the developer may contact RingCentral Developer Support if the problem persists.\n\n##### HTTP 503 – Service Unavailable\nThe server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state. \nIn some cases, this status indicates that server cannot handle just this particular type of requests while other can be processed.\nThe client may retry the original request after getting this HTTP code not earlier than in a number of seconds returned in `Retry-After` header (see [RFC 7231](https://tools.ietf.org/html/rfc7231#section-7.1.3)).\n\n##### Other 5xx\nThe client should not repeat the request. RingCentral Developer Support should be informed about the problem.\n\n### Authentication/Authorization Errors\nSince RingCentral API uses OAuth 2.0 for authorization, the server behavior is mostly governed by OAuth specification.\n\n* The behavior of RingCentral API Authorization flows is defined by OAuth 2.0 Specification ([RFC 6749](http://tools.ietf.org/html/rfc6749) and [RFC 6750](http://tools.ietf.org/html/rfc6750))\n* Regardless of the number of threads which send API requests to the server, the application should perform OAuth authentication in a single thread, store and share tokens to be used in all regular API requests. Backend servers enforce some quotas for the number of authorization requests and number of active application sessions. If the quota is exceeded at any given time, the server starts to return `HTTP 429` on authorization requests. \n* Application must avoid frequent authentication attempts under the same user credentials. In order to extend session after access token expiration, it has to use token refreshment flow (if allowed)\n* Application should store `expires_in` and `refresh_token_expires_in` values along with access/refresh tokens and their issue time. This value is to be used to pre-check if the token is expired or about to expire before sending regular API requests in order to refresh tokens proactively. It is strongly recommended to avoid performing refreshment basing on `HTTP 401` errors which are returned by the server.\n* According to OAuth 2.0 standard some logical error codes are returned in error field of the response.\n\n#### OAuth Authorize \nFor 3-legged OAuth flows in some cases `HTTP 400` may be returned on `/restapi/oauth/authorize` call. For example, it can happen when the client provides invalid redirect URI in the request. See [RFC 6749](http://tools.ietf.org/html/rfc6749) for details.\n\n#### OAuth Token\nAs a general rule, if a request to /restapi/oauth/token API for access token fails client must NOT send other API requests until resolved. It should be properly orchestrated if client uses multiple threads which share the same tokens to send regular API requests.\n\n* `HTTP 400` – do not repeat request; if possible inform the user about failure and prompt for new credentials \n* `HTTP 429`, `HTTP 503` – retry in an indicated interval returned in Retry-After header.\n* `HTTP 4xx`, `HTTP 5xx` – do not repeat request, error in client or server code\n* `HTTP 400` – use cached credentials (if possible) to re-authenticate, or prompt user for new credentials.\n* `HTTP 408`, `HTTP 500`, client timeout – repeat 3 times with 10 seconds intervals, then try re-request tokens using cached credentials (if possible), or prompt user for new credentials (all dependent regular requests should be queued and wait for resolution)\n\n#### OAuth Revoke \nIn case of any error on the request to `/restapi/oauth/revoke` API client should just ignore it and do not retry.\n\n### Connection Errors Handling\nThere is a possibility that the Client Application is not able to establish a connection(s) with RingCentral service(s) for some reasons like \"Connection Timeout\", \"SSL Handshake Failure\" or other connection failures.\n\nThis situation might indicate problems on a backend side and it is very important to not overwhelm the backend with unnecessary client requests in this case.\n\nIn the described situation Client Application should follow an \"Exponential Backoff\" approach:\n\"The retries exponentially increase the waiting time up to a certain threshold. The idea is that if the server is down temporarily, it is not overwhelmed with requests hitting at the same time when it comes back up.\"\n\nThe following Retry Delays are recommended for Client Applications in case of any Connection Failures:\n\n2 seconds\n3 seconds\n5 seconds\n8 seconds\n13 seconds\n21 seconds\n30 seconds\n\nKeep trying to connect every 30 seconds\n\n"},{"title":"Error Codes","description":"The API uses specific error codes to make error processing for client applications more simple and effective. The body of HTTP response should be always logged and analyzed. It is sometimes impossible to understand the reason for the issue by only HTTP status code. Error code from the body should be also taken into consideration.\n\nClient app should rely on `errorCcode` and, in some cases, on additional fields like `parameterName`, not on error `message` because of it can be changed in next versions of the API and localized according to `Accept-Language` header if the language is supported by RingCentral service. Response body with error message can contain several error messages and has the following structure:\n\n```http\n{\n \"errorCode\": \"LegacyCode\", //legacy logical error code, deprecated. Will not be supported in later versions of API\n \"message\": \"Error message\", //legacy error message\n \"errors\": [\n {\n \"errorCode\": \"ABC-123\", //error code\n \"message\": \"Error message\", //error message\n \"additionalInfo\": \"value\", //additional attribute for this error, e.g \"parameterName\": \"extensionId\"\n },\n {\n \"errorCode\": \"XYZ-321\",\n \"message\": \"Second error message\"\n }\n ]\n}\n```\n\nPossible error codes for each API method are listed in method description under **Error Codes** header.\n\n### Common Error Codes\nThe following error codes potentially might be returned on any API call:\n\n| HTTP Code | Error Code | Error Message | Typical Reason |\n|-----------|------------|---------------|----------------|\n| `400` | `CMN-101` | Parameter [*parameterName*] value is invalid | Parameter value type is incorrect; enumeration value is unsupported; or the mandatory parameter is missed |\n| `400` | `CMN-104` | Cannot parse request | Request body for POST/PUT method is empty |\n| `400` | `CMN-406` | Duplicate value for parameter *parameterName*: *parameterValue* found in request | Request is invalid, see the message |\n| `400` | `CMN-407` | Unable to parse *headerName* header value: \"*headerValue*\" | Request header value is incorrect or unsupported |\n| `403` | `BIL-101` | Feature [*featureName*] is not available for current service plan | The feature is not included into the current user's account [Service Plan](https://success.ringcentral.com/articles/RC_Knowledge_Article/Billing-Service-Plan-RingCentral) |\n| `403` | `BIL-102` | Limit of *featureName* exceeded | Some limitation of current user's account [Service Plan](https://success.ringcentral.com/articles/RC_Knowledge_Article/Billing-Service-Plan-RingCentral) |\n| `403` | `BIL-103` | Feature [*featureName*] is not available for current account | The feature is turned off for the current user's account |\n| `403` | `CMN-112` | Feature [*featureName*] is not available for current extension type | The feature is not applicable for the current user's extension type |\n| `403` | `CMN-113` | Feature [*featureName*] is not available for current extension | The feature is turned off for the current user by account admin |\n| `403` | `CMN-404` | Attempt to access another extension | The resource belongs to another user and the current user has no access granted for the requested user resources|\n| `403` | `CMN-401` | In order to call this API endpoint, application needs to have [*permissionId*] permission | App key used at authorization stage does not grant the appropriate app permission, see [Application Permissions](#Application-Permissions) |\n| `403` | `CMN-408` | In order to call this API endpoint, user needs to have [*permissionId*] permission for requested resource. | The current user does not have the appropriate user permission granted, see [User Permissions](#User-Permissions) |\n| `404` | `CMN-102` | Resource for parameter [*parameterName*] is not found | The requested resource is not found by the ID specified; the resource could be already deleted, or the access to it is denied for the current user|\n| `404` | `CMN-120` | Invalid URI | There is no such method in the RingCentral Connect Platform API |\n| `409` | `CMN-204` | Resource is blocked by another operation | Another operation changing the requested resource is already in progress |\n| `429` | `CMN-301` | Request rate exceeded | Too many API calls from the same user (extension) by the current application, see also [Usage Plan Groups](#Usage Plan Groups) |\n| `500` | `CMN-203` | Internal Server Error | The server failed to run an apparently valid request |\n| `501` | `CMN-202` | Operation is not available | The requested action is currently unsupported by the API |\n| `503` | `CMN-201` | Service Temporary Unavailable | The server is currently unavailable being overloaded or down for maintenance |\n\n"},{"title":"Batch Requests","description":"One of the commonly used REST practices is the support of batch operations to retrieve multiple homogeneous resources by their key using a single request. The RingCentral API supports batch requests for a number of endpoints, for example messages, call records, blocked numbers, presence etc. They are implemented via the methods `GET`, `DELETE` and `PUT` with all their features. Batch operations are not transaction-atomic. Each resource in a batch is processed separately from the others, making it possible to receive different success/failure results for different resources wrapped in a multipart response object. The HTTP status code `207 Multi-Status` (Multi-Status) is returned in every multipart response object and indicates a batch request.\n\n---\n**Note**\n\nThe `207 Multi-Status` code is not returned in response body in case of error accessing the endpoint. For example, if the requested endpoint does not exist at all, `404 Not Found` status code is returned. If there is a server error, `5xx` status code is returned.\nIn batch `DELETE` operations (if all resources are deleted successfully) the server returns the `204 No content` instead of multi status (since all parts would be identical in this case). In case of at least one failure the server returns the `207 Multi-Status`.\n\n---\n\nApart from the top-level special status code in case of success, a multipart response object contains status codes in each part, representing a particular requested resource. This status specifies an individual result for each requested resource out of the batch. Let's consider the examples of batch request below.\n\n**Batch request for `GET` method**\n\n*1. Multipart/Mixed*\n \nRequest:\n\n```json\nGET /restapi/v1.0/account/~/extension/~/message-store/2447722008,2416832008 HTTP/1.1\nAccept: application/json\n```\nReponse:\n\n```json\nHTTP/1.1 207 Multi-Status\nContent-Type: multipart/mixed; boundary=Boundary_20_32057915_1351669531796\n\n--Boundary_20_32057915_1351669531796\nContent-Type: application/json\n\n{\n\"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/account/154364008/extension/154364008/message-store/2447722008\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n}, {\n \"href\" : \"https://platform.ringcentral.com/restapi/v1.0/account/154364008/extension/154364008/message-store/2416832008\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n} ]\n}\n--Boundary_20_32057915_1351669531796\nContent-Type: application/json\n\n{\n\"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/154364008/extension/154364008/message-store/2447722008\",\n\"id\" : 2447722008,\n\"to\" : [ {\n \"phoneNumber\" : \"18559100010\"\n} ],\n\"from\" : {\n \"phoneNumber\" : \"18559100010\"\n},\n\"type\" : \"SMS\",\n\"creationTime\" : \"2012-10-29T15:36:04.000Z\",\n\"readStatus\" : \"Unread\",\n\"priority\" : \"Normal\",\n\"attachments\" : [ {\n \"id\" : 1,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/154364008/extension/154364008/message-store/2447722008/content/1\",\n \"contentType\" : \"text/plain\"\n} ],\n\"direction\" : \"Inbound\",\n\"availability\" : \"Alive\",\n\"subject\" : \"verificationMessage\",\n\"messageStatus\" : \"Received\",\n\"conversationId\" : 5717224681082742945,\n\"lastModifiedTime\" : \"2012-10-29T15:36:04.000Z\"\n}\n--Boundary_20_32057915_1351669531796\nContent-Type: application/json\n\n{\n\"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/154364008/extension/154364008/message-store/2416832008\",\n\"id\" : 2416832008,\n\"to\" : [ {\n \"phoneNumber\" : \"18559100010\"\n} ],\n\"from\" : {\n \"phoneNumber\" : \"16509101086\"\n},\n\"type\" : \"SMS\",\n\"creationTime\" : \"2012-10-29T13:09:54.000Z\",\n\"readStatus\" : \"Unread\",\n\"priority\" : \"Normal\",\n\"attachments\" : [ {\n \"id\" : 1,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/154364008/extension/154364008/message-store/2416832008/content/1\",\n \"contentType\" : \"text/plain\"\n} ],\n\"direction\" : \"Inbound\",\n\"availability\" : \"Alive\",\n\"subject\" : \"Inbound SMS\",\n\"messageStatus\" : \"Received\",\n\"conversationId\" : 141549019326272744,\n\"lastModifiedTime\" : \"2012-10-29T13:09:54.000Z\"\n}\n--Boundary_20_32057915_1351669531796--\n\n```\n\n*2. Multipart+Json*\n\nRequest:\n\n```json\nGET /account/306059004/extension/306061004/message-store/972869004,111 HTTP/1.1\nAccept=application/vnd.ringcentral.multipart+json\n```\nResponse:\n\n```json\nHTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972869004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306059004/extension/306061004/message-store/972869004\",\n \"id\": 972869004,\n \"to\": [\n {\n \"phoneNumber\": \"+17607822229\",\n \"location\": \"Warner Springs, CA\"\n }\n ],\n \"from\": {\n \"phoneNumber\": \"+15013030165\",\n \"name\": \"Message #1\",\n \"location\": \"Benton, AR\"\n },\n \"type\": \"SMS\",\n \"creationTime\": \"2018-12-24T07:39:12.000Z\",\n \"readStatus\": \"Unread\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972869004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306059004/extension/306061004/message-store/972869004/content/972869004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"SMS: direction=Inbox delivery=DELIVERED unread=true\",\n \"messageStatus\": \"Queued\",\n \"conversationId\": 8234962969801172000,\n \"conversation\": {\n \"id\": \"8234962969801171948\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/8234962969801171948\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:11.666Z\"\n }\n },\n {\n \"resourceId\": \"111\",\n \"status\": 404,\n \"body\": {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"errors\": [\n {\n \"errorCode\": \"CMN-102\",\n \"message\": \"Resource for parameter [messageId] is not found\",\n \"parameterName\": \"messageId\"\n }\n ],\n \"parameterName\": \"messageId\"\n }\n }\n]\n```\n\n**Batch request for `PUT` method:**\n\n*1. Multipart/Mixed*\n\nThe client has to specify: \n - multipart/mixed content type and boundary;\n - modified fields for every single item which needs to be updated, separated by multipart boundaries.\n\nRequest:\n\n```json\nPUT /restapi/v1.0/account/~/extension/~/message-store/401654758008,401642088008 HTTP/1.1\nContent-Type: multipart/mixed; boundary=Boundary_1_15567762_1355833573664\n\n--Boundary_1_15567762_1355833573664\nContent-Type: application/json\n\n{\"readStatus\": \"Read\"}\n--Boundary_1_15567762_1355833573664\nContent-Type: application/json\n\n{\"readStatus\": \"Read\"}\n--Boundary_1_15567762_1355833573664--\n```\n\nResponse:\n\n```json\nHTTP/1.1 207 Multi-Status\nContent-Type: multipart/mixed; boundary=Boundary_1_15567762_1355833573664\n\n--Boundary_1_15567762_1355833573664\nContent-Type: application/json\n\n{\n\"response\" : [ {\n \"href\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401654758008\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n}, {\n \"href\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401642088008\",\n \"status\" : 200,\n \"responseDescription\" : \"OK\"\n} ]\n}\n--Boundary_1_15567762_1355833573664\nContent-Type: application/json\n\n{\n\"uri\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401654758008\",\n\"id\" : 401654758008,\n\"to\" : [ {\n \"phoneNumber\" : \"18559100010\"\n} ],\n\"type\" : \"Fax\",\n\"creationTime\" : \"2013-07-11T12:05:43.000Z\",\n\"readStatus\" : \"Read\",\n\"priority\" : \"Normal\",\n\"attachments\" : [ {\n \"id\" : 1,\n \"uri\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401654758008/content/1\",\n \"contentType\" : \"image/tiff\"\n} ],\n\"direction\" : \"Outbound\",\n\"availability\" : \"Alive\",\n\"messageStatus\" : \"SendingFailed\",\n\"faxResolution\" : \"Low\",\n\"faxPageCount\" : 0,\n\"lastModifiedTime\" : \"2013-07-11T12:26:24.000Z\"\n}\n--Boundary_1_15567762_1355833573664\nContent-Type: application/json\n\n{\n\"uri\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401642088008\",\n\"id\" : 401642088008,\n\"to\" : [ {\n \"phoneNumber\" : \"77653287256446\"\n} ],\n\"type\" : \"Fax\",\n\"creationTime\" : \"2013-07-11T08:45:57.000Z\",\n\"readStatus\" : \"Read\",\n\"priority\" : \"Normal\",\n\"attachments\" : [ {\n \"id\" : 1,\n \"uri\" : \"https://platform.ringcentral.com/account/400129284008/extension/400129284008/message-store/401642088008/content/1\",\n \"contentType\" : \"image/tiff\"\n} ],\n\"direction\" : \"Outbound\",\n\"availability\" : \"Alive\",\n\"messageStatus\" : \"SendingFailed\",\n\"faxResolution\" : \"Low\",\n\"faxPageCount\" : 0,\n\"lastModifiedTime\" : \"2013-07-11T12:26:52.000Z\"\n}\n--Boundary_1_15567762_1355833573664--\n\n```\n*2. Multipart+Json*\n \nRequest #1 (IDs in path):\n\n```json\nPUT /account/306065004/extension/306067004/message-store/972903004,972901004 HTTP/1.1\nContent-Type=application/vnd.ringcentral.multipart+json\n\n[\n {\n \"body\": {\n \"readStatus\": \"Read\"\n }\n },\n {\n \"body\": {\n \"readStatus\": \"Read\"\n }\n }\n]\n\n```\nRequest #2 (IDs in body):\n\n```json\nPUT /account/306065004/extension/306067004/message-store/* HTTP/1.1\nContent-Type=application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972903004\",\n \"body\": {\n \"readStatus\": \"Read\"\n }\n },\n {\n \"resourceId\": \"972901004\",\n \"body\": {\n \"readStatus\": \"Read\"\n }\n }\n]\n```\nResponse:\n\n```json\nHTTP 207 Multi-Status\nContent-Type: application/vnd.ringcentral.multipart+json\n\n[\n {\n \"resourceId\": \"972903004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004\",\n \"id\": 972903004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"Generated IM message\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972903004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972903004/content/972903004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"IM: direction=Outbox unread=false\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.873Z\",\n \"pgToDepartment\": false\n }\n },\n {\n \"resourceId\": \"972901004\",\n \"status\": 200,\n \"body\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004\",\n \"id\": 972901004,\n \"to\": [\n {\n \"extensionNumber\": \"103\",\n \"extensionId\": \"306068004\"\n }\n ],\n \"from\": {\n \"extensionNumber\": \"102\",\n \"extensionId\": \"306067004\",\n \"name\": \"Generated IM message\"\n },\n \"type\": \"Pager\",\n \"creationTime\": \"2018-12-24T10:39:24.000Z\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 972901004,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/306065004/extension/306067004/message-store/972901004/content/972901004\",\n \"type\": \"Text\",\n \"contentType\": \"text/plain\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"subject\": \"IM: direction=Outbox unread=true\",\n \"messageStatus\": \"Sent\",\n \"conversationId\": 6951365551500,\n \"conversation\": {\n \"id\": \"6951365551500\",\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/conversation/6951365551500\"\n },\n \"lastModifiedTime\": \"2018-12-24T10:39:31.879Z\",\n \"pgToDepartment\": false\n }\n }\n]\n\n```\n"}]},{"title":"Method Features","x-tag-group":"Using the API","description":"\n","children":[{"title":"Application Permissions","description":"\nIn order to work with the RingCentral API resources, the application should get the corresponding permissions. Each API method is marked with the required application permission under the *App Permission* header in method description. \nPermissions for the application can be selected, depending on resources it will be using, at the stage of app creation on Developers Portal and further on during the development process. The list of permissions available for the application depends on its type.\n\n![App Permissions](https://netstorage.ringcentral.com/dpw/api-reference/images/CreateAppOAuthSettings.png)\n\nOnly the permissions your app will actually be using should be requested, due to the following reasons:\n* for successful graduation to production API calls using all the permissions requested should be executed, which means the app should make at least one API call per each permission it has got, see also: [Apply for Production](https://developers.ringcentral.com/library/getting-started.html#ApplyForProduction)\n* at login stage the user will have to agree that the app will have access to his/her resources according to the actual app permissions to continue using the app, so the permission set should be reasonable.\n\nIf the app does **not** have the permission required for performing a certain API call, the API method will return `CMN-401` error code with the `HTTP 403 Forbidden` status, see also [Error Codes](#section-error-codes).\n\n\n \n**Application Permission List**\n\n| Permission | Usage | User Label | User Description | Access Level |\n|------------|-------|------------|------------------|--------------|\n| `Accounts` | Managing accounts: creating new accounts, viewing and updating account information, deleting existing accounts | Create, view and edit accounts | This permission enables the application to create accounts, view and modify account information, and delete accounts | 🔐 |\n| `CallControl` | Creating and managing phone calls aka telephony sessions | Call Control | This permission enables the application to manage call sessions: make calls, drop calls, forward calls, etc. | 🔐 |\n| `Contacts`\t| Creating, viewing, editing and deleting user personal contacts | Create, view and edit your personal contacts | This permission enables the application to create, view and change personal contacts information, and delete contacts | |\n| `EditAccounts` | Viewing and updating user account info (including name, business name, address and phone number/account number) | View and edit your account and extension data | This permission enables the application to view and modify your account as well as create, view, modify, and delete extensions | 🔐 |\n| `EditCallLog` | Viewing and updating user call logs | View and edit your call log | This permission enables the application to view and delete your call log| 🔐|\n| `EditCustomData` | Viewing and updating client custom data (key-value)| View and edit application-specific data | This permission enables the application to view and make changes to the application-specific data | 🔐 |\n| `EditExtensions` | Viewing and updating user extension info (includes extension name, number, email and phone number, assigned phone numbers, devices and other extension settings) | View and edit your extension data | This permission enables the application to view and update your extension information | |\n| `EditMessages` | Viewing and updating user messages | View and edit your messages | This permission enables the application to view, change and delete your messages | |\n| `EditPaymentInfo` | Viewing and updating account billing settings| View and edit billing settings | This permission enables the application to view and update account billing settings | 🔐 |\n| `EditPresence` | Getting and modifying user presence information | View and edit your presence | This permission enables the application to view and change your presence information | |\n| `Faxes` | Sending and receiving faxes| Send and view faxes | This permission enables the application to send and view fax messages | |\n| `Glip` | Working with Glip teams, users and messages | Send Glip messages and manage | This permission enables the application to send and view Glip messages, manage teams and users | 🔐 |\n| `InternalMessages` | Sending and receiving intra-company text messages | Send and edit internal text messages | This permission enables the application to send and edit internal text messages between account users | |\n| `IvrScripting` | Custom IVR call handling actions | Interactive voice response | This permissions enables the application to activate IVR actions: handle incoming calls to IVR, play greetings, collect DTMF | 🔐 |\n| `Meetings` | Creating, viewing, editing and deleting meetings| View and update your meetings | This permission enables application to schedule, read and update meeting info | |\n| `NumberLookup` | Looking-up and reserving available phone number | Lookup and reserve phone numbers | This permission enables the application to look up the list of available phone numbers and reserve numbers from the list | 🔐 |\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) | View your account and extension data | This permission enables the application to view your account and extension information | |\n| `ReadCallLog` | Viewing user call logs | View your call log | This permission enables the application to view your call log | |\n| `ReadCallRecording` | Downloading call recording content | View your call log and download call recordings | This permission enables the application to view your call log and download the audio call recordings | |\n| `ReadContacts` | Viewing user personal contacts | View your personal contacts | This permission enables the application to view your personal contacts information | | \n| `ReadMessages` | Viewing user messages | View your messages | This permission enables the application to view your messages | |\n| `ReadPresence` | Getting user presence information | View your presence | This permission enables the application to view your presence information | |\n| `RingOut` | Performing two-legged ring-out phone calls | Make RingOut calls on your behalf | This permission enables the application to make RingOut calls. The RingOut call is initiated as an inbound call from RC service to your specified phone which is then connected to the destination number | |\n| `SMS` | Sending and receiving (SMS) text messages | Send and view SMS messages | This permission enables the application to send and view SMS messages | |\n| `SubscriptionWebhook` | Managing push notification subscriptions which use Webhooks | Subscribe to webhook notifications | This permission enables the application to receive push notifications using webhook transport | |\n| `Voicemail` | Sending voicemail messages | Send voicemail messages | This permission enables the application to send voicemail messages | 🔐 |\n| `VoipCalling` | Register as VoIP device and making VoIP calls | Make and receive VoIP calls on your behalf | This permission enables the application to make and receive calls on your behalf | 🔐 | \n\n\n"},{"title":"User Permissions","description":"\nRingCentral supports role-based access control. Each user (extension) has one role assigned. On the API level, there might be a few roles assigned for one extension - some of them are automatically assigned according to some service plan options. Each role has a set of granted permissions. The user has a superset of permissions granted based on all the roles assigned to his/her extension (explicitly or auto-assigned).\n\nMost of the API methods have some permissions required for the API call to be successfully performed. Typically, it is one specific permission, which is mentioned under the **User Permission** header in method description in the API Reference. In case the user does not have the permission required, the error code `CMN-408` will be returned with the `HTTP 403 Forbidden` status code, see also: [Error Codes](#section-error-codes). To avoid unexpected error messages or even application crash the required permission can be checked with [Authorization Profile/Permission Check](https://developers.ringcentral.com/api-reference#Authorization-Profile) API before the target API call and the user interface properly adjusted (hiding/disabling some buttons, showing some tooltips, etc.)\n\nLearn more about RingCentral Roles and Permissions.\n\nSee also: Authorization Profile and Permission Invalidation.\n\n"},{"title":"Usage Plan Groups","description":"\n**Usage Plan** is a scheme specifying limits of using of API resources for a client application. Appliance of usage plans ensures consistent load allocation through correct interaction with the RingCentral Connect Platform. \n**Your application Usage Plan** is available on your RC account by clicking the ‘Rate Limits‘ on ‘Apps‘ tab; it specifies the supported number of requests of each API group and the request time frame in seconds. \n**Every API method** is marked as ‘Heavy’, ‘Medium’, ‘Light’ according to their processing, or ‘Auth’ for authorization requests; this mark can be found under the *Usage Plan Group* header in method description. \n*Example:*\n![Rate Limits](https://netstorage.ringcentral.com/dpw/api-reference/images/Rate_Limits.png)\n\nWithin the above given limits, the client application is allowed to send 10 heavy, 40 medium, 50 light and 5 authorization requests per user (RC extension) per minute. When exceeded the server returns `429 Too Many Requests` HTTP error code. It means the client is throttled by the server due to high request rate. The retry period in seconds is returned in the `Retry-After` header. In case the request is resent earlier (before the period specified in `Retry-After` header is over) the penalty interval is applied. The penalty interval value for requests of each API group is displayed in the corresponding column. \n\n**Please note** that the penalty interval will be renewed until the client waits for the required time interval to pass before sending new requests. If the client is constantly sending new requests, the penalty period would keep on renewing and would never expire.\n\nThe following **Rate Limits Headers** are returned for the limited API requests:\n* `X-Rate-Limit-Group` — API group of the request (Light, Medium, Heavy, Auth)\n* `X-Rate-Limit-Limit` — the current rate limit for the request\n* `X-Rate-Limit-Remaining` — the number of requests left for the time interval (window) of this rate limit\n* `X-Rate-Limit-Window` — time interval in seconds for the request rate limit\n\n"}]},{"title":"Localization","x-tag-group":"Using the API","description":"\n","children":[{"title":"Languages Support","description":"The content returned by RingCentral API is **not** localized in most cases as assumed to be machine readable, not human readable. It practically means that constants and enumerated values are returned in US English.\nHowever some API methods return localized content, as regards customer facing text and error messages.\nIn this case the client application can pass the preferred language (locale) code in the `Accept-Language` HTTP header. If this header is omitted, incorrect or contains unsupported language code, the server returns localized content in the language which is configured in user extension regional settings (by default, `en-US` for RingCentral US and Canada accounts, `en-GB` for RingCentral UK accounts). The language code is returned in the `Content-Language` HTTP header. \n\n"}]},{"title":"OAuth 2.0","x-tag-group":"Authentication","description":"\n","children":[{"title":"Authorization","description":"\n### Authorization Code Flow\n\nThe authorization code is obtained by using an authorization server as an intermediary between the client and resource owner. Returns link to a login page location. Web applications are higly advised to use the Proof Key for Code Exchange scheme (PKCE) for security concerns.\n\nWhen the client exchanges authorization code to access or refresh tokens, then `Authorization` header is not required. When the client refreshes a token belonging to a session opened using `authorization_code` grant type, then `Authorization` header is not required. In both cases the client must provide the `client_id` as a form data parameter to identify itself.\n\n\n**Usage Plan Group**\n\nAuth\n\n GET /restapi/oauth/authorize\n\n**Request Headers**\n\nClient app may pass localization language code value in `Accept-Language` header. But if any of these parameters `localeId` or `ui_locales` is specified, the header value is overwritten.\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **response\\_type** | string | Must be set to `code` | |\n| **redirect\\_uri** | string | This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration | |\n| **client\\_id** | string | Identifier (key) of a client application | |\n| **state** | string | Client state. Returned back to the client at the end of the flow | |\n| **brand\\_id** | string | Brand identifier. If it is not provided in request, server will try to determine brand from client app profile. The default value is `1210` - RingCentral US | |\n| **display** | string | Style of login form. The default value is `page`. The `popup` and `touch` values are featured for mobile applications | `page`
`popup`
`touch`
`mobile` |\n| **prompt** | string | Specifies which login form will be displayed. Space-separated set of the following values: `login` - official RingCentral login form, `sso` - Single Sign-On login form, `consent` - form to show the requested scope and prompt user for consent. Either `login` or `sso` (or both) must be specified. The default value is `login&sso` | |\n| **localeId** | string | Localization code of a language. Overwrites `Accept-Language` header value | |\n| **ui\\_locales** | string | Localization code of a language. Overwrites `localeId` parameter value | |\n| **ui\\_options** | string | User interface options data | `hide_logo` `hide_tos` `hide_remember_me` `external_popup` `old_ui` |\n| **code\\_challenge** | string | The code challenge. Once the app has generated the code verifier, it uses that to create the code challenge. For devices that can perform a SHA256 hash, the code challenge is a BASE64-URL-encoded string of the SHA256 hash of the code verifier. Clients that do not have the ability to perform a SHA256 hash are permitted to use the plain code verifier string as the challenge |\n| **code\\_challenge\\_method** |string | The code challenge method, either plain or S256, depending on whether the challenge is the plain verifier string or the SHA256 hash of the string. If this parameter is omitted, the server assumes plain |\n\n\n**Response Body**\n\nLink to a login page location.\n\n**Example**\n\nRequest\n```HTTP\nGET /restapi/oauth/authorize?client_id=A50F55593E224b381E81D6A969391D0e49E27FB9A1C3\n&redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Foauthredirect&response_type=code&state=ABC123&prompt=login\n```\nResponse\n```HTTP\nHTTP/1.1 302 Found\n\nLocation:\nhttps://service.ringcentral.com/mobile/loginDispatcher?session=2008293087662283621&clientId=A50F55593E224b381E81D6A969391D0e49E27FB9A1C3\n&state=ABC123&brandId=1210&appUrlScheme=https%3A%2F%2Fmyapp%2Eexample%2Ecom%2Foauthredirect&localeId=en_US&display=page&prompt=login&hideNavigationBar=true \n```\n\n**PKCE Example**\n\nRequest\n```HTTP\nGET /restapi/oauth/authorize?client_id=wsewtqavk&redirect_uri=https://app.test.com&response_type=code&code_challenge=U0pDMTFQMDFQQVMwMXxBQUJfTVpHWk5lM29zNVFmWnNHQ01MSmJuMHJmNGlRcnRaeEptTWlPS0&code_challenge_method=S256\n\n```\nResponse\n```HTTP\nHTTP/1.1 302 Found\n\nLocation:\nhttps://service.ringcentral.com/mobile/loginDispatcher?session=2008293087662283621&clientId=A50F55593E224b381E81D6A969391D0e49E27FB9A1C3\n&state=ABC123&brandId=1210&appUrlScheme=https%3A%2F%2Fmyapp%2Eexample%2Ecom%2Foauthredirect&localeId=en_US&display=page&prompt=login&hideNavigationBar=true&code_challenge=U0pDMTFQMDFQQVMwMXxBQUJfTVpHWk5lM29zNVFmWnNHQ01MSmJuMHJmNGlRcnRaeEptTWlPS0&code_challenge_method=S256 \n\n```\n \n### Implicit Grant Type Flow\n\nReturns login page location. And upon successful login - access token embedded in a link redirecting to a client web application. Please note: Access token obtained via this request expires in an hour and can be refreshed by sending this request repeatedly.\n\n**Request Headers**\n\nClient app may pass localization language code value in `Accept-Language` header. But if any of these parameters `localeId` or `ui_locales` is specified, the header value is overwritten.\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **response\\_type** | string | Must be set to token | |\n| **redirect\\_uri** | string |This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration | |\n| **client\\_id**| string | Identifier (key) of a client application | |\n| **state** | string | Client state. Returned back to the client at the end of the flow | |\n| **brand\\_id** | string | Brand identifier. If it is not provided in request, server will try to determine brand from client app profile. The default value is `1210` - RingCentral US | |\n| **display** | string | Style of login form. The default value is `page`. The `popup` and `touch` values are featured for mobile applications | `page`
`popup`
`touch`
`mobile` |\n| **prompt** | string | Specifies which login form will be displayed. Space-separated set of the following values: `login` - official RingCentral login form, `sso` - Single Sign-On login form, `consent` - form to show the requested scope and prompt user for consent. Either `login` or `sso` (or both) must be specified. Please note: The value must be set to `none` for all requests except for the first one | |\n| **ui\\_locales** | string | Localization code of a language. Overwrites `localeId` parameter value | |\n| **localeId** | string | Localization code of a language. Overwrites `Accept-Language` header value | |\n| **ui\\_options** | string | User interface options data | `hide_logo` `hide_tos` `hide_remember_me` `external_popup` `old_ui` |\n\n**Response Body**\n\nLink to a login page location. \nAfter successful user login the browser will pass the hash fragment with access token directly to the application redirect URI.\n\n**Example**\n\nRequest\n```HTTP\nGET https://api.ringcentral.com/restapi/oauth/authorize?response_type=token&client_id=9oQlL98tTQGhpdqq5KB60Q&state=xyz&prompt=login%20consent&\nredirect_uri=http%3A%2F%2Fmyapp%2Eexample%2Ecom%2Foauthredirect HTTP/1.1\n```\nResponse\n```HTTP\nHTTP/1.1 302 Found\n\nLocation:\nhttps://service.ringcentral.com/mobile/loginDispatcher?session=2008293087662283621&clientId=9oQlL98tTQGhpdqq5KB60Q&state=xyz\n&brandId=1210&appUrlScheme=http%3A%2F%2Fmyapp%2Eexample%2Ecom%2Foauthredirect&localeId=en_US&display=page&prompt=login%20consent&hideNavigationBar=true\n```\nCallback Request\n```\nhttp://myapp.example.com/oauthredirect#access_token=tuyt43gjhg6u54uiy6iuyhh3k45jh34k5hO6884534jk5hkh83yh3kj5h348y59345ikh&token_type=bearer&state=xyz&expires_in=3600\n```\n\n"},{"title":"Get Token","description":"\nThis endpoint enables client applications to get access tokens for making API requests. Requests to this endpoint must be authenticated with HTTP Basic scheme using the client ID and client secret as login and password, correspondingly.\n\n### Authorization Code Flow\n\nEach time you call token endpoint using this flow a new client session starts. It is associated with the issued token pair: access token and refresh token, returned in response to this request. To continue the session you can refresh the obtained access token and refresh token as many times as you need, using Refresh Token flow or the same flow.\n\nTo start another client session you should call token endpoint using this flow again. Please consider that only 5 simultaneously active sessions per extension per application are supported. Thus if you exceed the number of sessions started per extension per application, the oldest one is ended.\n\n**Usage Plan Group**\n\nAuth\n\n POST /restapi/oauth/token\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **grant\\_type** | string | Must be set to `authorization_code` for authorization code flow | |\n| **code** | string | Authorization code | |\n| **redirect\\_uri** | string |This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration | URI |\n| **access\\_token\\_ttl** | integer | Access token lifetime in seconds; the possible values are from 600 sec (10 min) to 3600 sec (1 hour). The default value is 3600 sec. If the value specified exceeds the default one, the default value is set. If the value specified is less than 600 seconds, the minimum value (600 sec) is set | |\n| **refresh\\_token\\_ttl** | integer | Refresh token lifetime in seconds. The maximum allowed value is 7 days. If the value is not specified or exceeds the maximum value, then by default the maximum value is applied| |\n| **code\\_verifier** | string | The code verifier parameter passed in PKCE token retrieval request (where `grant_type` equals to `authorization_code`) that is originally generated by the app before the authorization request | |\n\n**Response Body**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **access\\_token** | string | Access token to pass to subsequent API requests | |\n| **expires\\_in** | integer | Issued access token TTL (time to live), in seconds | |\n| **refresh\\_token** | string | Refresh token to get a new access token, when the issued one expires | |\n| **refresh\\_token\\_expires\\_in** | integer | Issued refresh token TTL (time to live), in seconds | |\n| **scope** | string | List of permissions allowed with this access token, white-space separated | |\n| **token\\_type** | string | Type of token. The only possible value supported is `Bearer`. This value should be used when specifying access token in Authorization header of subsequent API requests | |\n| **owner\\_id** | string | Extension identifier | |\n| **endpoint\\_id** | string | Unique identifier of a client application. You can pass it in request according to pattern `[a-zA-Z0-9_\\-]{1,64}`. Otherwise it is auto-generated by server. The value will be returned in response in both cases | |\n\n**Example**\n\nRequest\n```HTTP\nPOST /restapi/oauth/token \n\ncode=U0pDMDFQMDRQQVMwMnxBQUFGTVUyYURGYi0wUEhEZ2VLeGFiamFvZlNMQlZ5TExBUHBlZVpTSVlhWk\nxYajg5aDA3UVJmZ3VHdTNOTk05YkR0MEw0RkhnMlRPdTZuMTJSdEYwUkZyZHBSNWtLUzlzc1V8eW1OWVhRf\nFdnUW5QcExvYVhrN3lqY3p5NEJwWHc&grant_type=authorization_code&redirect_uri=https://www.example.com/myapp\n``` \nResponse\n```HTTP\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"access_token\" : \"U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw\",\n \"token_type\" : \"bearer\",\n \"expires_in\" : 7199,\n \"refresh_token\" : \"U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w\",\n \"refresh_token_expires_in\" : 604799,\n \"scope\" : \"AccountInfo CallLog ExtensionInfo Messages SMS\",\n \"owner_id\" : \"256440016\"\n}\n```\n\n### Password Flow\n\nEach time you call token endpoint using this flow a new client session starts. It is associated with the issued token pair: access token and refresh token, returned in response to this request. To continue the session you can refresh the obtained access token and refresh token as many times as you need, using Refresh Token flow or the same flow.\n\nTo start another client session you should call token endpoint using this flow again. Please consider that only 5 simultaneously active sessions per extension per application are supported. Thus if you exceed the number of sessions started per extension per application, the oldest one is ended.\n\n**Usage Plan Group**\n\nAuth\n\n POST /restapi/oauth/token\n\n**Request Headers**\n\nThe `Content-Type` header should be specified as `application/x-www-form-urlencoded`. Please note: Request body should be encoded appropriately. For example email `john+doe@example.com` as username parameter should be specified so - `john%2Bdoe%40example.com`.\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **grant\\_type** | string | Must hold `password` value for Resource Owner Credentials flow. If client application is not authorized by the specified `grant_type`, response does not contain `refresh_token` and `refresh_token_ttl` attributes | |\n| **access\\_token\\_ttl** | integer |Access token lifetime in seconds; the possible values are from 600 sec (10 min) to 3600 sec (1 hour). The default value is 3600 sec. If the value specified exceeds the default one, the default value is set. If the value specified is less than 600 seconds, the minimum value (600 sec) is set | |\n| **refresh\\_token\\_ttl** | integer | Refresh token lifetime in seconds. The default value depends on the client application, but as usual it equals to 7 days. If the value specified exceeds the default one, the default value is applied. If client specifies refresh_token_ttl<=0, refresh token is not returned even if the corresponding grant type is supported | |\n| **username** | string | Phone number in E.164 format (including the following format `*`) or an email address linked to account or extension. Please note: You cannot use one and the same email address for authorization on different extensions (even if they are assigned to different accounts) | |\n| **extension** | string | Extension short number. Please note: If company number is specified as username, and extension number is not provided neither in username nor in extension attributes, then the server attempts to authenticate the client as a main company administrator. If a username is provided in a new format - with extension specified via asterisk (for example `18001234567*123`) then extension attribute is ignored | |\n| **password** | string | User password | |\n| **endpoint\\_id** | string | Unique identifier of a client application. You can pass it in request according to pattern `[a-zA-Z0-9_\\-]{1,64}`. Otherwise it is auto-generated by server. The value will be returned in response in both cases | |\n\n**Response Body**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **access\\_token** | string | Access token to pass to subsequent API requests | |\n| **expires\\_in** | integer | Issued access token TTL (time to live), in seconds | |\n| **refresh\\_token** | string | Refresh token to get a new access token, when the issued one expires | |\n| **refresh\\_token\\_expires\\_in** | integer | Issued refresh token TTL (time to live), in seconds | |\n| **scope** | string | List of permissions allowed with this access token, white-space separated | |\n| **token\\_type** | string | Type of token. The only possible value supported is `Bearer`. This value should be used when specifying access token in Authorization header of subsequent API requests | |\n| **owner\\_id** | string | Extension identifier | |\n\n**Example 1: Phone number as a username**\n\nRequest\n```HTTP\nPOST /restapi/oauth/token HTTP/1.1\nAccept: application/json\nContent-Type: application/x-www-form-urlencoded\nAuthorization: Basic cmVsLWFsbC1wZXJtaXNzaWXFjMmpRZmlQcnlkSUkweE92QQ==\n\ngrant_type=password&username=18559100010*123&password=121212\n```\nResponse\n```HTTP\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"access_token\" : \"U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw\",\n \"token_type\" : \"bearer\",\n \"expires_in\" : 7199,\n \"refresh_token\" : \"U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w\",\n \"refresh_token_expires_in\" : 604799,\n \"owner_id\" : \"256440016\"\n} \n```\n\n**Example 2: Email address as a username**\n\nRequest\n```HTTP\nPOST /restapi/oauth/token HTTP/1.1\nAccept: application/json\nContent-Type: application/x-www-form-urlencoded\nAuthorization: Basic cmVsLWFsbC1wZXJtaXNzaWXFjMmpRZmlQcnlkSUkweE92QQ==\n \ngrant_type=password&username=john%2Bdoe%40example.com&password=121212\n```\nResponse\n```HTTP\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"access_token\" : \"U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw\",\n \"token_type\" : \"bearer\",\n \"expires_in\" : 7199,\n \"refresh_token\" : \"U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w\",\n \"refresh_token_expires_in\" : 604799,\n \"owner_id\" : \"256440016\"\n}\n```\n\n### Refresh Token Flow\n\nEach time you call token endpoint using this flow, you continue current client session, and receive a new token pair: access token and refresh token in response to this request. The old token pair immediately becomes inactive.\n\n**Usage Plan Group**\n\nAuth\n\n POST /restapi/oauth/token\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **refresh\\_token** | string | Previously issued refresh token | |\n| **grant\\_type** | string | Must hold refresh_token value | |\n| **endpoint\\_id** | string | Unique identifier of a client application. If not specified, the previously specified or auto-generated value is used by default |\n\n**Response Body**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **access\\_token** | string | Access token to pass to subsequent API requests | |\n| **expires\\_in** | integer | Issued access token TTL (time to live), in seconds | |\n| **refresh\\_token** | string | Refresh token to get a new access token, when the issued one expires | |\n| **refresh\\_token_expires_in** | integer | Issued refresh token TTL (time to live), in seconds | |\n| **scope** | string | List of permissions allowed with this access token, white-space separated | |\n| **token\\_type** | string | Type of token. The only possible value supported is `Bearer`. This value should be used when specifying access token in Authorization header of subsequent API requests | |\n| **owner\\_id** | string | Extension identifier | |\n\n**Example**\n\nRequest\n```HTTP\n POST /restapi/oauth/token HTTP/1.1\n Accept: application/json\n Content-Type: application/x-www-form-urlencoded\n Authorization: Basic cmVsLWFsbC1wZXJtaXNzaWXFjMmpRZmlQcnlkSUkweE92QQ==\n\n refresh_token=BCMDFUMDRKV1MwMXx5d5dwzLFL4ec6U1A0XMsUv935527jghj48&grant_type=refresh_token\n```\nResponse\n```HTTP\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{\n \"access_token\" : \"U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw\",\n \"token_type\" : \"bearer\",\n \"expires_in\" : 7199,\n \"refresh_token\" : \"U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w\",\n \"refresh_token_expires_in\" : 6048799,\n \"scope\" : \"AccountInfo CallLog ExtensionInfo Messages SMS\" \n}\n```\n\n"},{"title":"Revoke Token","description":"\nRevokes access/refresh token. Requests to this endpoint **must** be authenticated with HTTP Basic scheme using client ID and client secret as login and password, correspondingly.\n\n**Usage Plan Group**\n\nAuth\n\n /restapi/oauth/revoke\n\n**Form Data Parameters**\n\n| Parameter | | Description | |\n|---|---|---|---|\n| **token** | string | Active access or refresh token to be revoked |\n\n**Response Body**\n\nNone\n\n**Example**\n\nRequest\n```HTTP\nPOST /restapi/oauth/revoke HTTP/1.1\nContent-Type: application/x-www-form-urlencoded\nAuthorization: Basic M2ZmYjNlMThkZDU4ZDE1YTk2NTIwYmFmNzUzZjBiNzk6MzI5OWQ0NTg5NGU1Njg5ODllOTY1ZTFiMTk5MGU2OTI\n\ntoken=U0pDMDFQMDFKV1MwMXwJ_W7L1fG4eGXBW9Pp-otywzriCw\n```\nResponse\n```HTTP\nHTTP/1.1 200 OK\n```\n"}]},{"title":"Notification Types","x-tag-group":"Events & Notifications","description":"Notifications which the client wants to receive can be specified by the **event filters** which are set in the subscription request. The event filter is exposed as a URL, pointing to the required RingCentral API resource. Currently the following event types are available for notifications: extensions, messages and presence. They are described in detail below.\n\n\n","children":[{"title":"Account Presence Event","description":" \n*Since 1.0.26 (Release 8.2)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/presence` enables notifications in case of change of presence information for any extension assigned to the current account.\n \n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Notification Payload Structure**\n \nThe client receives non-detailed presence notification payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Presence Event\t | Notification payload body |\n\n**Presence Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `extensionId\t` | string | Internal identifier of an extension |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony presence status. Returned if telephony status is changed. See Telephony Status Values |\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `presenceStatus` | 'Offline' or 'Busy' or 'Available' | Aggregated presence status, calculated from a number of sources |\n| `userStatus` | 'Offline' or 'Busy' or 'Available' | User-defined presence status (as previously published by the user) |\n| `meetingsStatus` | 'Connected' or 'Disconnected' | Meetings presence status |\n| `dndStatus` | 'TakeAllCalls' or 'DoNotAcceptAnyCalls' or 'DoNotAcceptDepartmentCalls' | Extended DnD (Do not Disturb) status |\n| `allowSeeMyPresence` | boolean | If 'True' enables other extensions to see the extension presence status |\n| `ringOnMonitoredCall` | boolean | If 'True' enables to ring extension phone, if any user monitored by this extension is ringing |\n| `pickUpCallsOnHold` | boolean | If 'True' enables the extension user to pick up a monitored line on hold |\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"045b81dc-9f73-4864-84de-08aa6324a7f5\",\n \"event\": \"/restapi/v1.0/account/~/extension/6610372004/presence\",\n \"timestamp\": \"2016-02-18T09:37:24.597Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": \"6610372004\",\n \"body\": {\n \"extensionId\": 6610372004,\n \"telephonyStatus\": \"CallConnected\",\n \"sequence\": 2698,\n \"presenceStatus\": \"Busy\",\n \"userStatus\": \"Available\",\n \"meetingStatus\": \"Disconnected\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": false\n }\n } \n ```\n\n"},{"title":"Account Telephony Sessions Event","description":" \n*Since 1.0.36 (Release 10.2)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/telephony/sessions` enables notifications in case of change of session information for any extension assigned to the current account.\n\nThe client receives detailed call notification payload as a JSON object.\n\n**Required Permissions**\n\n| Permission | Description |\n|---------------|-----------------------|\n| `CallControl` | Creating and managing telephony sessions |\n\n\n**Query Parameters**\n\n| Parameter | Type | Description |\n|---------------|--------------------|\n| `direction` | 'Outbound' or 'Inbound' | Allows to send notifications only on call(s) with a specified direction |\n| `missedCall` | boolean | Allows to send notifications only on missed call(s) event | \n| `phoneNumber` | string | Allows to send notifications only on call(s) to/from a certain phone number; e.164 format with '+' sign is supported |\n| `sipData` | boolean | Enables detailed notifications with SIP information |\n| `statusCode` | 'Setup' or 'Proceeding' or 'Answered' or 'Disconnected' or 'Gone' or 'Parked' or 'Hold' or 'VoiceMail' or 'FaxReceive' or 'VoiceMailScreening' | Enables notifications on call sessions with a particular status. It is possible to subscribe to multiple statuses via different event filters |\n\n**Notification Payload Structure**\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Telephony Sessions Event | Session changes of the party |\n\n\n**Telephony Sessions Event**\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `sessionId` | string | Legacy identifier of a call session |\n| `telephonySessionId` | string | Call session identifier, required for Telephony API |\n| `serverId` | string | Identifier of a server |\n| `eventTime` | string | The call start datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `origin` | Session Origin Details | Session Origin Details |\n| `parties` | Session Parties Details | Call participants details |\n\n**Session Origin Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `type` | string | The reason of Session creation. Could be 'Call' or 'RingOut' or 'RingMe' or 'Conference' or 'GreetingsRecording' or 'VerificationCall' or 'TestCall' |\n\n**Session Parties Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `accountId` | string | Internal identifier of an account |\n| `extensionId` | string | Internal identifier of an extension |\n| `id` | string | Internal identifier of a party, globaly unique |\n| `direction` | 'Inbound' or 'Outbound' | Technical call direction. 'Inbound' direction often means the call in the party context is initiated from RC to Customer endpoint. 'Outbound' is vice versa, e.g. User make outbound call from any of RC application. |\n| `to` | Callee Info | Callee Info |\n| `from` | Caller Info | Caller Info |\n| `status` | Session Status Info | Session Status Info |\n| `missedCall` | boolean | If 'True' means the call was missed by the party |\n| `standAlone` | boolean | Indicates whether the call party is standalone or not |\n| `muted` | boolean | If 'True' means the party is muted |\n| `conferenceRole` | 'Host' or 'Participant'| Defines party role in Server Side Conference |\n| `sipData` | SIP Info | SIP (Session Initiation Protocol) information. Returned if query parameter `sipData` is set to 'True' |\n\n**Callee Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Callee Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `name` | string | Callee Name |\n| `extensionId` | string | Internal identifier of an Callee extension |\n\n**Caller Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Caller Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `name` | string | Caller Name |\n| `extensionId` | string | Internal identifier of a Caller extension |\n\n**Session Status Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `code` | string | State Code for the party |\n| `reason` | string | Might be specified for some codes to add more details |\n| `parkData` | string | Appears in 'Parked' state. |\n| `peerId` | Linked Session Details | Contains details of the 'linked' Session. Appears in 'Gone' State Code |\n| `mobilePickupData` | Mobile Pickup Data | Appears if the user configured to answer the call via Desktop/Mobile application |\n\n**SIP Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `toTag` | string | Recipient data |\n| `fromTag` | string | Sender data|\n| `callId` | string | SIP call identifier |\n\n\n**Linked Session Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `sessionId` | string | Legacy identifier of a linked call session |\n| `telephonySessionId` | string | Call session identifier, required for Telephony API|\n| `partyId` | string | Party identifier of a linked call session |\n\n\n**Mobile Pickup Data**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `ccMailboxes` | string | List of extension IDs, configured to pick a call from Desktop/Mobile applications |\n| `to` | string | SIP proxy registration name |\n| `sid` | string | User data |\n| `srvLvl` | string | User data |\n| `srvLvlExt` | string | User data |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"837270960869181944\",\n \"subscriptionId\": \"5c37f936-fa66-4b4b-95af-1e94b51a748d\",\n \"ownerId\": \"400144455008\",\n \"pn_apns\": {\n \"aps\": {\n \"content-available\": 1\n },\n \"uuid\": \"837270960869181944\",\n \"event\": \"/restapi/v1.0/account/400144452008/extension/400144455008/telephony/sessions\",\n \"timestamp\": \"2018-06-05T00:14:50.181Z\",\n \"subscriptionId\": \"5c37f936-fa66-4b4b-95af-1e94b51a748d\",\n \"ownerId\": \"400144455008\",\n \"body\": {\n \"sequence\": 5,\n \"sessionId\": \"402936341008\",\n \"telephonySessionId\": \"Y3MxNzE4NDE5MDM0MzQwMTgzODRAMTAuNjIuMjUuMTEx\",\n \"serverId\": \"10.62.25.111.TAM\",\n \"eventTime\": \"2018-06-05T00:14:50.147Z\",\n \"accountId\": \"400144452008\",\n \"parties\": [\n { \n \"sipData\":{\n \"callId\":\"555555555555\",\n \"toTag\":\"123\",\n \"fromTag\":\"456\"\n },\n \"extensionId\": \"400144455008\",\n \"id\": \"cs171841903434018384-2\",\n \"direction\": \"Inbound\",\n \"to\": {\n \"phoneNumber\": \"102\",\n \"name\": \"Tom Sawyer\",\n \"extensionId\": \"400144455008\"\n },\n \"from\": {\n \"phoneNumber\": \"103\",\n \"name\": \"TheCat Jerry\",\n \"extensionId\": \"400144457008\"\n },\n \"status\": {\n \"code\": \"Proceeding\",\n \"mobilePickupData\": {\n \"ccMailboxes\": [\n \"400144455008\"\n ],\n \"to\": \"#19008@example.com:5060\",\n \"sid\": \"402936472080\",\n \"srvLvl\": \"-149699523\",\n \"srvLvlExt\": \"390\"\n }\n },\n \"missedCall\": false,\n \"standAlone\": false,\n \"muted\": false\n }\n ],\n \"origin\": {\n \"type\": \"Call\"\n },\n \"extensionId\": \"400144455008\"\n }\n }\n }\n```\n\n"},{"title":"Company Directory Event","description":" \n*Since 1.0.32 (Release 9.3)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/directory/entries` enables notifications in case of change of the following fields of a company directory contact entry:\n\n* status\n* firstName\n* lastName\n* name\n* department\n* email\n* extensionNumber\n* site\n* etag\n* adding/removal of a contact phone number \n\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Notification Payload Structure**\n \nThe client receives presence line notifications payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Contact Event | Notification payload body |\n\n**Contact Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` |string| Internal identifier of an extension |\n| `eventType` | string | Type of change |\n| `type` | string | Type of extension | \n| `status` | 'Disabled' or 'Enabled' or 'NotActivated' | Status of an extension|\n| `firstName`| string | First name of a user extension |\n| `lastName` | string | Last name of a user extension |\n| `name` | string | Name of a contact, for non-user extensions|\n| `department` | string | Department name |\n| `email` | string | Email of an extension user |\n| `extensionNumber` | string | Extension number |\n| `account` | Account Info | Account data of an extension|\n| `phoneNumbers` | Collection of Phone Number Info | Extension phone numbers information |\n| `site` | Site Info | Site data |\n| `profileImage` | Profile Image Info | Extension profile image information. Not returned if profile images are absent for an extension |\n\n**Account Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` |string| Internal identifier of an account |\n\n\n**Phone Number Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` |string| Extension phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format |\n| `usageType` | 'MobileNumber' or 'ContactNumber' or 'DirectNumber' or 'ForwardedNumber' | Usage type of a phone number|\n| `type` | 'VoiceOnly' or 'FaxOnly' or 'VoiceFax' | Type of a phone number|\n\n**Site Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` |string| Internal identifier of a site. For Main Site the value is `main-site` |\n| `name` | string | Custom name of a site |\n\n\n**Profile Image Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uri` |string| Link to a profile image resource |\n| `etag` | string| Internal identifier of an image |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"ed1cf00c-0420-4bf5-a0ae-e659cc9f77e0\",\n \"event\": \"/restapi/v1.0/account/400386146004/directory/entries\",\n \"timestamp\": \"2017-09-27T12:00:00.000Z\",\n \"subscriptionId\": \"3rtt23ryy-56665-t7r7-a0ae-748895yhhf94ujrr\",\n \"body\": {\n \"contacts\": [{\n \"eventType\": \"Update\",\n \"id\": \"8798797945\",\n \"type\": \"User\",\n \"status\": \"Enabled\",\n \"name\": \"John Smith\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"department\": \"Sales\",\n \"email\": \"john.smith@example.com\",\n \"extensionNumber\": \"103\",\n \"account\": {\n \"id\": \"12345\"\n },\n \"phoneNumbers\": [{\n \"phoneNumber\": \"+12345672134\",\n \"usageType\": \"DirectNumber\",\n \"type\": \"VoiceFax\"\n }\n ],\n \"profileImage\": {\n \"etag\": \"a4cf0cfe3eff6c81b8c0bab7f3649502\"\n },\n \"site\": {\n \"id\": \"12345678\",\n \"name\": \"West branch\"\n }\n }\n ]\n }\n}\n```\n\n\n\n"},{"title":"Detailed Extension Presence Event","description":" \n*Since 1.0.6 (Release 5.15)*\n \n1. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence?detailedTelephonyState=true` enables detailed notifications in case of any change of extension presence information:\n\n2. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/presence?detailedTelephonyState=true` enables detailed notifications in case of changes of presence information for extensions monitored by the current extension. \n\n3. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite/presence?detailedTelephonyState=true` enables detailed notifications if presence status of any extension included in favorites list of the current extension is changed. \n\nPlease note: If both simple presence and detailed presence event types are specified in getting subscription request, then the detailed presence notifications will be received.\n\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadPresence` | Getting user presence information |\n \n**Notification Payload Structure**\n \nThe client receives non-detailed presence notification payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Presence Event\t | Notification payload body |\n\n**Detailed Presence Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony presence status. Returned if telephony status is changed. See Telephony Status Values |\n| `activeCalls` | Collection of Active Call Info | List of the latest 7 active calls on extension |\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `presenceStatus` | 'Offline' or 'Busy' or 'Available' | Aggregated presence status, calculated from a number of sources |\n| `userStatus` | 'Offline' or 'Busy' or 'Available' | User-defined presence status (as previously published by the user) |\n| `meetingsStatus` | 'Connected' or 'Disconnected' | Meetings presence status |\n| `dndStatus` | 'TakeAllCalls' or 'DoNotAcceptAnyCalls' or 'DoNotAcceptDepartmentCalls' | Extended DnD (Do not Disturb) status |\n| `allowSeeMyPresence` | boolean | If 'True' enables other extensions to see the extension presence status |\n| `ringOnMonitoredCall` | boolean | If 'True' enables to ring extension phone, if any user monitored by this extension is ringing |\n| `pickUpCallsOnHold` | boolean | If 'True' enables the extension user to pick up a monitored line on hold |\n| `totalActiveCalls`| integer | Total number of active calls on extension at the present moment |\n\n**Active Call Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a call |\n| `direction` | 'Inbound' or 'Outbound' |Call direction|\n| `queueCall` | boolean | Identifies if a call belongs to the call queue |\n| `from` | string | Phone number or extension number of a caller |\n| `fromName` | string | Optional. Caller Name |\n| `to` | string | Optional. Phone number or extension number of a callee |\n| `toName` | string | Callee name |\n| `startTime` | dateTime | Datetime of actual start of the call in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony call status. See Telephony Status Values for detailed status description |\n| `terminationType` | 'final' | Type of call termination. Supported for calls in 'NoCall' status. Termination type 'intermediate', meaning the connection exists on one of the devices, is deprecated|\n| `sessionId` | string | Internal identifier of a call session |\n| `telephonySessionId` | string | Telephony identifier of call session |\n| `partyId` | string | Internal identifier of a call party |\n| `onBehalfOf` | string | Extension ID of the call owner on whose behalf a call is performed |\n\n**Example**\n\n```HTTP\n {\n \"uuid\": \"045b81dc-9f73-4864-84de-08aa6324a7f5\",\n \"event\": \"/restapi/v1.0/account/~/extension/6610372004/presence?detailedTelephonyState=true\",\n \"timestamp\": \"2016-02-18T09:37:24.597Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": \"6610372004\",\n \"body\": {\n \"extensionId\": 6610372004,\n \"telephonyStatus\": \"CallConnected\",\n \"activeCalls\": [\n {\n \"id\": \"39247ebfdc324e3b96d7519672aec3e4\",\n \"direction\": \"Inbound\",\n \"queueCall\": true,\n \"from\": \"+18775380038\",\n \"fromName\": \"John Wang\",\n \"to\": \"+18445810019\",\n \"telephonyStatus\": \"CallConnected\",\n \"startTime\" : \"2016-02-18T09:37:24.322Z\",\n \"sessionId\": \"17133704004\",\n \"partyId\":\"cs171843418296416309-2\",\n \"telephonySessionId\":\"Y3MxNjk4ODA5MTYxMzUyOTU5OUAxMC4zMi40NS44NA\"\n },\n {\n \"id\": \"39247ebfdc324e3b96d7519672aec3e5\",\n \"direction\": \"Outbound\",\n \"queueCall\": false,\n \"from\": \"+18776480025\",\n \"to\": \"+18445654321\",\n \"startTime\" : \"2016-02-18T09:37:24.322Z\"\n \"telephonyStatus\": \"NoCall\",\n \"sessionId\": \"17133804005\",\n \"partyId\": \"cs671843418296416309-2\",\n \"telephonySessionId\": \"Y3MxNjytruODA5MTYxMzUyOTU5OUAxMC4zMi40NS44NA\"\n }\n ],\n \"sequence\": 2698,\n \"presenceStatus\": \"Busy\",\n \"userStatus\": \"Available\",\n \"meetingStatus\": \"Disconnected\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": false,\n \"totalActiveCalls\": 2\n }\n } \n ```\n \n"},{"title":"Detailed Extension Presence with SIP Event","description":" \n*Since 1.0.6 (Release 5.15)*\n \n1. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence?detailedTelephonyState=true&sipData=true` enables detailed notifications with SIP information in case of any change of extension presence information:\n\n2. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/presence?detailedTelephonyState=true&sipData=true` enables detailed notifications with SIP information in case of changes of presence information for extensions monitored by the current extension. \n\n3. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite/presence?detailedTelephonyState=true&sipData=true` enables detailed notifications with SIP information if presence status of any extension included in favorites list of the current extension is changed.\n\nPlease note: If you specify that `sipData=true` then `presence?detailedTelephonyState=true` also, as SIP data is a part of active calls section. If both detailed presence and detailed presence with SIP event types are specified in getting subscription request, then the detailed presence with SIP notifications will be returned.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadPresence` | Getting user presence information |\n \n**Notification Payload Structure**\n \nThe client receives detailed presence with SIP notifications payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Detailed Presence with SIP Event | Notification payload body |\n\n**Detailed Presence with SIP Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony presence status. Returned if telephony status is changed. See Telephony Status Values |\n| `activeCalls` | Collection of Active Call Info | Telephony presence status. Returned if telephony status is changed. See Telephony Status Values |\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `presenceStatus` | 'Offline' or 'Busy' or 'Available' | Aggregated presence status, calculated from a number of sources |\n| `userStatus` | 'Offline' or 'Busy' or 'Available' | User-defined presence status (as previously published by the user) |\n| `meetingsStatus` | 'Connected' or 'Disconnected' | Meetings presence status |\n| `dndStatus` | 'TakeAllCalls' or 'DoNotAcceptAnyCalls' or 'DoNotAcceptDepartmentCalls' | Extended DnD (Do not Disturb) status |\n| `allowSeeMyPresence` | boolean | If 'True' enables other extensions to see the extension presence status |\n| `ringOnMonitoredCall` | boolean | If 'True' enables to ring extension phone, if any user monitored by this extension is ringing |\n| `pickUpCallsOnHold` | boolean | If 'True' enables the extension user to pick up a monitored line on hold |\n| `totalActiveCalls`| integer | Total number of active calls on extension at the present moment |\n\n**Active Call Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a call |\n| `direction` | 'Inbound' or 'Outbound' |Call direction|\n| `queueCall` | boolean | Identifies if a call belongs to the call queue |\n| `from` | string | Phone number or extension number of a caller |\n| `fromName` | string | Optional. Caller Name |\n| `to` | string | Optional. Phone number or extension number of a callee |\n| `toName` | string | Calee Name |\n| `startTime` | dateTime | Datetime of actual start of the call in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony call status. See Telephony Status Values for detailed status description |\n| `terminationType` | 'final' | Type of call termination. Supported for calls in 'NoCall' status. Termination type 'intermediate', meaning the connection exists on one of the devices, is deprecated|\n| `sessionId` | string | Internal identifier of a call session |\n| `sipData` | SIP Data | SIP connection settings |\n| `telephonySessionId` | string | Telephony identifier of call session |\n| `partyId` | string | Internal identifier of a call party |\n| `onBehalfOf` | string | Extension ID of the call owner on whose behalf a call is performed |\n\n**SIP Data**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `toTag` | string | Recipient data |\n| `fromTag` | string | Sender data |\n| `remoteUri` | string | Remote address URL |\n| `localUri` | string | Local address URL |\n\n**Example**\n\n```HTTP\n {\n \"uuid\": \"4956997212540532738\",\n \"event\": \"/restapi/v1.0/account/37439510/extension/297277020/presence?detailedTelephonyState=true&sipData=true\",\n \"timestamp\": \"2019-07-09T16:17:38.286Z\",\n \"subscriptionId\": \"dfbca25e-4e2b-4c60-aa8d-47a83716fe23\",\n \"ownerId\": \"297277020\",\n \"body\": {\n \"extensionId\": 297277020,\n \"telephonyStatus\": \"OnHold\",\n \"activeCalls\": [\n {\n \"id\": \"1nf2mhj51dp3asb3l0r5\",\n \"direction\": \"Outbound\",\n \"queueCall\": true,\n \"fromName\": \"Charlie Williams\",\n \"from\": \"+16508370072\",\n \"toName\": \"Alice Smith\",\n \"to\": \"4591\",\n \"telephonyStatus\": \"OnHold\",\n \"sipData\": {\n \"toTag\": \"7lcee2ho88\",\n \"fromTag\": \"10.14.20.199-5070-63fbd8da20314c\",\n \"remoteUri\": \"do-not-use-me-I-am-example\",\n \"localUri\": \"do-not-use-me-I-am-example\"\n },\n \"sessionId\": \"118139132021\",\n \"startTime\": \"2019-07-09T16:17:27.975Z\",\n \"partyId\": \"p-9cdb248614c94aa7ba68135f6c07b808-1\",\n \"telephonySessionId\": \"s-9cdb248614c94aa7ba68135f6c07b808\"\n },\n {\n \"id\": \"s-e1e9696d863742758a18654dcc22a2fd\",\n \"direction\": \"Inbound\",\n \"queueCall\": false,\n \"fromName\": \"Charlie Williams\",\n \"from\": \"66666\",\n \"toName\": \"Bob Brown\",\n \"to\": \"66666\",\n \"telephonyStatus\": \"Ringing\",\n \"sipData\": {\n \"toTag\": \"blf\",\n \"fromTag\": \"p-e1e9696d863742758a18654dcc22a2fd-2\",\n \"remoteUri\": \"do-not-use-me-I-am-example\",\n \"localUri\": \"do-not-use-me-I-am-example\"\n },\n \"sessionId\": \"118139217021\",\n \"startTime\": \"2019-07-09T16:17:37.705Z\",\n \"partyId\": \"p-e1e9696d863742758a18654dcc22a2fd-2\",\n \"telephonySessionId\": \"s-e1e9696d863742758a18654dcc22a2fd\"\n }\n ],\n \"sequence\": 2013,\n \"presenceStatus\": \"Busy\",\n \"userStatus\": \"Available\",\n \"dndStatus\": \"TakeAllCalls\",\n \"meetingStatus\": \"Disconnected\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": true,\n \"pickUpCallsOnHold\": true,\n \"totalActiveCalls\": 2\n }\n }\n```\n\n"},{"title":"Extension Favorites Event","description":" \n*Since 1.0.26 (Release 8.2)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite` enables notifications in case of extension favorite list changes.\n\nThe updated extension data is accessible by calling the [Get Favorite Contact List](https://developers.ringcentral.com/api-reference/External-Contacts/listFavoriteContacts) method.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadContacts` | Viewing user personal contacts |\n \n**Notification Payload Structure**\n \nThe client receives extension favorites list notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Extension Info | Notification payload body |\n\n**Extension Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"8b5594e0-d659-4e25-b36b-980ad907ae55\",\n \"event\": \"/restapi/v1.0/account/~/extension/9141626004/favorite\",\n \"timestamp\": \"2016-03-17T14:36:08.302Z\",\n \"subscriptionId\": \"2242051f-2980-4612-84ab-2d25e2efce2c\",\n \"ownerId\": 9141626004,\n \"body\": {\n \"extensionId\": 9141626004\n }\n } \n ```\n\n"},{"title":"Extension Grant List Event","description":" \n*Since 1.0.15 (Release 7.0)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/grant` enables notifications in case of extension grant list changes.\n\nThe updated extension data is accessible by calling the [Get Extension Grant List](https://developers.ringcentral.com/api-reference#User-Settings-listExtensionGrants) method.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Notification Payload Structure**\n \nThe client receives extension grant list notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Extension Grant List Event | Notification payload body |\n\n**Extension Grant List Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n\n\n**Example**\n\n```HTTP\n{ \n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659cc9f77e0\",\n \"event\":\"/restapi/v1.0/account/~/extension/8475874957/grant\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": 8475874957,\n \"timestamp\": \"2015-02-24T12:00:00.000Z\",\n \"body\":{ \n \"extensionId\": 8475874957\n }\n}\n ```\n\n"},{"title":"Extension Info Event","description":"\n*Since 1.0.15 (Release 7.0)*\n \nEvent filter /restapi/v1.0/account/{accountId}/extension/{extensionId} enables notifications in case of the current extension changes:\n\n* addition/removal of extensions to/from account\n* contact info (first/last name; company name; email; business phone; business address)\n* status\n* regional settings (timezone, home country, language, greeting language, formatting locale, time format)\n* permissions (administrator permission, international calling)\n* phone numbers (assign/unassign)\n* departments (added to/removed from)\n* service features (for the current extension only) - *SMS/SMSReceiving*, *Pager/PagerReceiving*, *Fax/FaxReceiving*, *Voicemail*, *EncryptionAtRest*, *BlockedMessageForwarding*, *DnD*, *RingOut*, *InternationalCalling*, *Presence*, *Conferencing*, *VoIPCalling*, *CallPark*, *OnDemandCallRecording*\n\nIf the client is subscribed to the current event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}` then notifications will be sent whenever any extension information change occurs. The `hints` property value returned in notification body helps to distinguish what type of change was actually made; each hint is mapped to the corresponding API method that can be called to get the required change. Please consider the 'Hints' table at the bottom of this page.\n\nThe full updated extension data is accessible by calling the [Get Extension Info](https://developers.ringcentral.com/api-reference#User-Settings-loadExtensionInfo) method.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Notification Payload Structure**\n \nThe client receives extension info notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Extension Info Event | Notification payload body |\n\n**Extension Info Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `eventType` | 'Update' or 'Delete' | Type of change |\n| `hints` | Collection of Hints | Returned for 'Update' event type only. See the list of supported hints and the corresponding APIs in the table below|\n\n\n**Hints**\n\n| Hint | Target API | \n|-----------|------|\n| `AccountSettings` | `account/~` |\n| `AccountStatus` | `account/~` |\n| `AnsweringRules` | `account/~/extension/~`|\n| `CompanyNumbers` | `account/~/extension/~/phone-number` |\n| `DialingPlan` | `account/~/dialing-plan` |\n| `ExtensionInfo` | `account/~/extension/~/` |\n| `Features` | `account/~/extension/~/features` |\n| `Limits` | `account/~/extension/~/features` |\n| `Permissions` | `account/~/extension/~/features` |\n| `ProfileImage` | `/account/~/extension/~/profile-image` |\n| `VideoConfiguration`| `account/~/extension`, `account/~/extension/~/` |\n\n\n\n**Example**\n\n```HTTP\n{ \n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659cc9f77e0\",\n \"event\":\"/restapi/v1.0/account/~/extension/8475874957\",\n \"timestamp\": \"2013-06-14T12:00:00.000Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": 8475874957,\n \"body\":{ \n \"extensionId\": \"8475874957\",\n \"eventType\": \"Update\",\n \"hints\": [ \"ExtensionInfo\", \"CompanyNumbers\"] \n }\n}\n ```\n\n"},{"title":"Extension List Event","description":" \n*Since 1.0.15 (Release 7.0)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension` enables notifications in case of extension list changes:\n\n* addition/removal of extensions to/from account\n* contact info (first/last name; company name; email; business phone; business address)\n* status\n* regional settings (timezone, home country, language, greeting language, formatting locale, time format)\n* permissions (administrator permission, international calling)\n* phone numbers (assign/unassign)\n* departments (added to/removed from)\n* service features (for the current extension only) - *SMS/SMSReceiving*, *Pager/PagerReceiving*, *Fax/FaxReceiving*, *Voicemail*, *EncryptionAtRest*, *BlockedMessageForwarding*, *DnD*, *RingOut*, *InternationalCalling*, *Presence*, *Conferencing*, *VoIPCalling*, *CallPark*, *OnDemandCallRecording*\n\nThe updated extension data is accessible by calling the methods [Get Extension List](https://developers.ringcentral.com/api-reference#Account-Provisioning-listExtensions) and/or [Get Extension Info](https://developers.ringcentral.com/api-reference#User-Settings-loadExtensionInfo).\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Notification Payload Structure**\n \nThe client receives extension list notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Extension List Event | Notification payload body |\n\n**Extension List Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `eventType` | 'Create' or 'Update' or 'Delete' | Type of change |\n| `hints` | Collection of Hints | Returned for 'Update' event type only. See the list of supported hints and the corresponding APIs in the table below|\n\n**Hints**\n\n| Hint | Target API | \n|-----------|------|\n| `AccountSettings` | `account/~` |\n| `AccountStatus` | `account/~` |\n| `AnsweringRules` | `account/~/extension/~`|\n| `CompanyNumbers` | `account/~/extension/~/phone-number` |\n| `DialingPlan` | `account/~/dialing-plan` |\n| `ExtensionInfo` | `account/~/extension/~/` |\n| `Features` | `account/~/extension/~/features` |\n| `Limits` | `account/~/extension/~/features` |\n| `Permissions` | `account/~/extension/~/features` |\n| `ProfileImage` | `/account/~/extension/~/profile-image` |\n| `VideoConfiguration`| `account/~/extension`, `account/~/extension/~/` |\n\n\n\n**Example**\n\n```HTTP\n{\n \"timestamp\": \"2014-04-29T14:29:27.408+0000\",\n \"subscriptionId\": \"a45645-0001-cc71-9de3-674476722\",\n \"ownerId\": 1500723004,\n \"uuid\": \"b11c9430-9687-4498-b12b-3fcb470bfe04\",\n \"event\": \"/restapi/v1.0/account/~/extension\",\n\n \"body\": { \"extensions\":[ \n { \n \"extensionId\": \"74953947939\",\n \"eventType\": \"Delete\"\n },\n { \n \"extensionId\": \"8798797945\",\n \"eventType\": \"Create\"\n },\n { \n \"extensionId\": \"8475874957\",\n \"eventType\": \"Update\",\n \"hints\": [ \"ExtensionInfo\", \"CompanyNumbers\"] \n }\n ]\n }\n } \n ```\n\n"},{"title":"Extension Presence Event","description":" \n*Since 1.0.6 (Release 5.15)*\n \n1. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence` enables notifications in case of any change of non-detailed presence information:\n\n2. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/presence` enables notifications in case of changes of presence information for extensions monitored by the current extension. \n\n3. Event filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite/presence` enables notifications if presence status of any extension included in favorites list of the current extension is changed.\n\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadPresence` | Getting user presence information |\n \n**Notification Payload Structure**\n \nThe client receives non-detailed presence notification payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Presence Event\t | Notification payload body |\n\n**Presence Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `extensionId\t` | string | Internal identifier of an extension |\n| `telephonyStatus` | 'NoCall' or 'CallConnected' or 'Ringing' or 'OnHold' or 'ParkedCall' | Telephony presence status. Returned if telephony status is changed. See Telephony Status Values |\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `presenceStatus` | 'Offline' or 'Busy' or 'Available' | Aggregated presence status, calculated from a number of sources |\n| `userStatus` | 'Offline' or 'Busy' or 'Available' | User-defined presence status (as previously published by the user) |\n| `meetingsStatus` | 'Connected' or 'Disconnected' | Meetings presence status |\n| `dndStatus` | 'TakeAllCalls' or 'DoNotAcceptAnyCalls' or 'DoNotAcceptDepartmentCalls' | Extended DnD (Do not Disturb) status |\n| `allowSeeMyPresence` | boolean | If 'True' enables other extensions to see the extension presence status |\n| `sequence`| integer | Order number of a notification to state the chronology | \n| `ringOnMonitoredCall` | boolean | If 'True' enables to ring extension phone, if any user monitored by this extension is ringing |\n| `pickUpCallsOnHold` | boolean | If 'True' enables the extension user to pick up a monitored line on hold |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"045b81dc-9f73-4864-84de-08aa6324a7f5\",\n \"event\": \"/restapi/v1.0/account/~/extension/6610372004/presence\",\n \"timestamp\": \"2016-02-18T09:37:24.597Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": \"6610372004\",\n \"body\": {\n \"extensionId\": 6610372004,\n \"telephonyStatus\": \"CallConnected\",\n \"sequence\": 2698,\n \"presenceStatus\": \"Busy\",\n \"userStatus\": \"Available\",\n \"meetingStatus\": \"Disconnected\",\n \"dndStatus\": \"TakeAllCalls\",\n \"allowSeeMyPresence\": true,\n \"ringOnMonitoredCall\": false,\n \"pickUpCallsOnHold\": false\n }\n } \n ```\n\n"},{"title":"Extension Presence Line Event","description":" \n*Since 1.0.16 (Release 7.1)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line` enables notifications in case of change of presence of extension(s) monitored by the current extension.\n\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadPresence` | Getting user presence information |\n \n**Notification Payload Structure**\n \nThe client receives presence line notifications payload as a JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Presence Line Event | Notification payload body |\n\n**Presence Line Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `extension` | Extension Info | Extension information |\n| `sequence` | integer | Order number of a notification to state the chronology |\n\n**Extension Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of the extension |\n| `id` | string | Internal identifier of the returned line |\n\n**Example**\n\n```HTTP\n{ \n \"timestamp\": \"2014-04-29T13:23:12.468+0000\",\n \"uuid\": \"a295fa1f-af6a-4518-b333-acf091bdd7ea\",\n \"event\": \"/restapi/v1.0/account/~/extension/406149828004/presence/line\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": 406149828004,\n \"body\": {\n \"extension\": {\n \"id\": \"677628004765\"\n },\n {\n \"id\": \"3\"\n },\n {...}\n \n },\n \"sequence\": 2698,\n\n } \n```\n\n"},{"title":"Extension Telephony Sessions Event","description":" \n*Since 1.0.36 (Release 10.2)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions` enables notifications in case of change of session information of specified extension.\n\nThe client receives detailed call notification payload as a JSON object.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `CallControl` | Creating and managing telephony sessions |\n\n\n**Query Parameters**\n\n| Parameter | Type | Description |\n|---------------|--------------------|\n| `direction` | 'Outbound' or 'Inbound' | Allows to send notifications only on call(s) with a specified direction |\n| `missedCall` | boolean | Allows to send notifications only on missed call(s) event | \n| `phoneNumber` | string | Allows to send notifications only on call(s) to/from a certain phone number; e.164 format with '+' sign is supported |\n| `sipData` | boolean | Enables detailed notifications with SIP information |\n| `statusCode` | 'Setup' or 'Proceeding' or 'Answered' or 'Disconnected' or 'Gone' or 'Parked' or 'Hold' or 'VoiceMail' or 'FaxReceive' or 'VoiceMailScreening' | Enables notifications on call sessions with a particular status. It is possible to subscribe to multiple statuses via different event filters |\n\n**Notification Payload Structure**\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Telephony Sessions Event | Body of Telephony Session Event |\n\n\n**Telephony Sessions Event**\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `sequence` | integer | Order number of a notification to state the chronology |\n| `sessionId` | string | Legacy identifier of a call session |\n| `telephonySessionId` | string | Call session identifier, required for Telephony API |\n| `serverId` | string | Identifier of a server |\n| `eventTime` | string | The call start datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `origin` | Session Origin Details | Session Origin Details |\n| `parties` | Session Parties Details | Call participants details |\n\n**Session Origin Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `type` | string | The reason of Session creation. Could be 'Call' or 'RingOut' or 'RingMe' or 'Conference' or 'GreetingsRecording' or 'VerificationCall' or 'TestCall' |\n\n**Session Parties Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `accountId` | string | Internal identifier of an account |\n| `extensionId` | string | Internal identifier of an extension |\n| `id` | string | Internal identifier of a party, globaly unique |\n| `direction` | 'Inbound' or 'Outbound' | Technical call direction. 'Inbound' direction often means the call in the party context is initiated from RC to Customer endpoint. 'Outbound' is vice versa, e.g. User make outbound call from any of RC application. |\n| `queueCall` | boolean | Identifies if a call belongs to the call queue |\n| `to` | Callee Info | Callee Info |\n| `from` | Caller Info | Caller Info |\n| `status` | Session Status Info | Session Status Info |\n| `missedCall` | boolean | If 'True' means the call was missed by the party |\n| `standAlone` | boolean | Indicates whether the call party is standalone or not |\n| `muted` | boolean | If 'True' means the party is muted |\n| `conferenceRole` | 'Host' or 'Participant'| Defines party role in Server Side Conference |\n| `sipData` | SIP Info | SIP (Session Initiation Protocol) information. Returned if query parameter `sipData` is set to 'True' |\n\n**Callee Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Callee Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I)(with '+' sign) format |\n| `name` | string | Callee Name |\n| `extensionId` | string | Internal identifier of an Callee extension |\n\n**Caller Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Caller Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `name` | string | Caller Name |\n| `extensionId` | string | Internal identifier of an Caller extension |\n\n**Session Status Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `code` | string | State Code for the party |\n| `reason` | string | Might be specified for some codes to add more details |\n| `parkData` | string | Appears in 'Parked' state. |\n| `peerId` | Linked Session Details | Contains details of the 'linked' Session. Appears in 'Gone' State Code |\n| `mobilePickupData` | Mobile Pickup Data | Appears, if User configured to answer the call on Desktop/Mobile applications|\n\n**SIP Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `toTag` | string | Recipient data |\n| `fromTag` | string | Sender data|\n| `callId` | string | SIP call identifier |\n\n**Linked Session Details**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `sessionId` | string | Legacy identifier of a linked call session |\n| `telephonySessionId` | string | Linked call session identifier, required for Telephony API |\n| `partyId` | string | Party identifier of a linked call session |\n\n\n**Mobile Pickup Data**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `ccMailboxes` | string | The list of extension IDs, configured to pick a call from Desktop/Mobile applications |\n| `to` | string | SIP proxy registration name |\n| `sid` | string | User data |\n| `srvLvl` | string | User data |\n| `srvLvlExt` | string | User data |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"837270960869181944\",\n \"subscriptionId\": \"5c37f936-fa66-4b4b-95af-1e94b51a748d\",\n \"ownerId\": \"400144455008\",\n \"pn_apns\": {\n \"aps\": {\n \"content-available\": 1\n },\n \"uuid\": \"837270960869181944\",\n \"event\": \"/restapi/v1.0/account/400144452008/extension/400144455008/telephony/sessions\",\n \"timestamp\": \"2018-06-05T00:14:50.181Z\",\n \"subscriptionId\": \"5c37f936-fa66-4b4b-95af-1e94b51a748d\",\n \"ownerId\": \"400144455008\",\n \"body\": {\n \"sequence\": 5,\n \"sessionId\": \"402936341008\",\n \"telephonySessionId\": \"Y3MxNzE4NDE5MDM0MzQwMTgzODRAMTAuNjIuMjUuMTEx\",\n \"serverId\": \"10.62.25.111.TAM\",\n \"eventTime\": \"2018-06-05T00:14:50.147Z\",\n \"accountId\": \"400144452008\",\n \"parties\": [\n { \n \"sipData\":{\n \"callId\":\"555555555555\",\n \"toTag\":\"123\",\n \"fromTag\":\"456\"\n },\n \"extensionId\": \"400144455008\",\n \"id\": \"cs171841903434018384-2\",\n \"direction\": \"Inbound\",\n \"to\": {\n \"phoneNumber\": \"102\",\n \"name\": \"Tom Sawyer\",\n \"extensionId\": \"400144455008\"\n },\n \"from\": {\n \"phoneNumber\": \"103\",\n \"name\": \"TheCat Jerry\",\n \"extensionId\": \"400144457008\"\n },\n \"queueCall\": true,\n \"status\": {\n \"code\": \"Proceeding\",\n \"mobilePickupData\": {\n \"ccMailboxes\": [\n \"400144455008\"\n ],\n \"to\": \"#19008@sip-mesdevams.lab.nordigy.ru:5060\",\n \"sid\": \"402936472080\",\n \"srvLvl\": \"-149699523\",\n \"srvLvlExt\": \"390\"\n }\n },\n \"missedCall\": false,\n \"standAlone\": false,\n \"muted\": false\n }\n ],\n \"origin\": {\n \"type\": \"Call\"\n },\n \"extensionId\": \"400144455008\"\n }\n }\n }\n```\n\n"},{"title":"Inbound Fax Event","description":"*Since 1.0.37 (Release 10.3)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax?direction=Inbound` enables notifications in case of new inbound fax message:\n\nThe updated message info is accessible by calling the Get Message List method.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadMessages` | Viewing user messages |\n\n**Notification Payload Structure**\n \nThe client receives messages notifications payload as JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2018-03-10T18:07:52.534Z* |\n| `body` | Fax Message Event | Notification payload body |\n\n**Fax Message Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message |\n| `to` | Collection of Recipient Info | Message receiver(s) information |\n| `from` | Sender Info | Message sender information |\n| `type` | string | Type of a message. The value is 'Fax' |\n| `creationTime` | datetime | Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `lastModifiedTime` | datetime | Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `readStatus` | string | Status of a message. The default value is 'Unread' |\n| `priority` | string | The default value is 'Normal' |\n| `attachments` | Collection of Instant Message Attachment Info | Message attachment data |\n| `direction` | string | Message direction. The default value is 'Inbound' |\n| `availability` | string | Message availability status. The default value is 'Alive' |\n| `subject` | string | Message subject. It replicates message text which is also returned as an attachment |\n| `messageStatus` | string | Status of a message. The default value is 'Received' |\n| `conversationId` | string | Internal identifier of a conversation this message belongs to |\n| `faxResolution` | string | Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi)|\n| `faxPageCount` | integer | Page count of a fax message |\n\n\n**Recipient Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `target` | boolean | 'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Sender Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Fax Message Attachment Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message attachment |\n| `uri` | string | Link to an attachment resource |\n| `size` | integer | Attachment size in bytes |\n| `type` | 'AudioRecording' or 'AudioTranscription'| Type of a message attachment |\n| `contentType` | string | Content type of an attachment, see also MIME Types |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659bb9f77e0\",\n \"event\": \"/restapi/v1.0/account/~/extension/823476228762/fax?direction=Inbound\",\n \"subscriptionId\": \"dc853541-66ac-45d8-a289-1a239fd72888\",\n \"ownerId\": \"823476228762\",\n \"timestamp\": \"2018-02-28T10:06:15.000Z\",\n \"body\": {\n \"id\": 404068973008,\n \"from\": {\n \"phoneNumber\": \"+14029997777\"\n },\n \"type\": \"Fax\",\n \"creationTime\": \"2018-02-28T05:11:37.000Z\",\n \"readStatus\": \"Unread\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": 404068973008,\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/404161512008/extension/404161514008/message-store/404068973008/content/404068973008\",\n \"type\": \"RenderedDocument\",\n \"contentType\": \"application/pdf\"\n }\n ],\n \"direction\": \"Inbound\",\n \"availability\": \"Alive\",\n \"subject\": \"+17015402626\",\n \"messageStatus\": \"Received\",\n \"faxResolution\": \"High\",\n \"faxPageCount\": 2,\n \"lastModifiedTime\": \"2018-02-28T05:11:37.673Z\"\n }\n}\n ```\n\n"},{"title":"Instant Message Event","description":"\n*Since 1.0.26 (Release 8.2)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/instant?type=SMS` enables notifications in case of receiving a new inbound SMS message.\n \nThe updated message info is accessible by calling the Get Message List method.\n\n**Notification Payload Structure**\n \nThe client receives messages notifications payload as JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2018-03-10T18:07:52.534Z* |\n| `body` | Instant Message Event | Notification payload body |\n\n**Instant Message Event**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message |\n| `to` | Collection of Recipient Info | Message receiver(s) information |\n| `from` | Sender Info | Message sender information |\n| `type` | string | Type of a message. The default value is 'SMS' |\n| `creationTime` | datetime | Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `lastModifiedTime` | datetime | Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `readStatus` | string | Status of a message. The default value is 'Unread' |\n| `priority` | string | The default value is 'Normal' |\n| `attachments` | Collection of Instant Message Attachment Info | Message attachment data |\n| `direction` | string | Message direction. The default value is 'Inbound' |\n| `availability` | string | Message availability status. The default value is 'Alive' |\n| `subject` | string | Message subject. It replicates message text which is also returned as an attachment |\n| `messageStatus` | string | Status of a message. The default value is 'Received' |\n| `conversationId` | string | Identifier of the conversation the message belongs to |\n\n**Recipient Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `target` | boolean | 'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Sender Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Instant Message Attachment Info**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message attachment |\n| `uri` | string | Link to an attachment resource |\n| `size` | integer | Attachment size in bytes |\n| `type` | 'AudioRecording' or 'AudioTranscription' or 'RenderedDocument' or 'Text' or 'MmsAttachment' | Type of a message attachment. The default value is 'Text' |\n| `contentType` | string | Content type of an attachment, see also MIME Types. The default value is 'text/plain' |\n\n**Example**\n\n```HTTP\n{\n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659bb9f77e0\",\n \"event\": \"/restapi/v1.0/account/~/extension/823476228762/message-store/instant?type=SMS\",\n \"subscriptionId\": \"dc853541-66ac-45d8-a289-1a239fd72888\",\n \"ownerId\": \"823476228762\",\n \"timestamp\": \"2013-06-14T12:00:00.000Z\",\n \"body\": {\n \"id\" : \"606090030016\",\n \"to\" : [ {\n \"phoneNumber\" : \"+16508974563\",\n \"location\" : \"Moss Beach, CA\",\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+14157809227\",\n \"name\" : \"John Smith\"\n },\n \"type\" : \"SMS\",\n \"creationTime\" : \"2016-02-22T17:01:00.000Z\",\n \"lastModifiedTime\" : \"2016-02-22T17:01:00.000Z\",\n \"readStatus\" : \"Unread\", \n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"uri\" : \"/restapi/v1.0/account/~/extension/823476228762/message-store/2640223004/content/2640223004\"\n \"id\" : \"606090030016\",\n \"type\" : \"Text\",\n \"contentType\" : \"text/plain\",\n \"size\": 4096\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"subject\" : \"Hi there\",\n \"messageStatus\" : \"Received\",\n \"conversationId\" : \"7876416245344257449\"\n }\n}\n ```\n\n"},{"title":"Message Event","description":"\n*Since 1.0.6 (Release 5.15)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store` enables notifications in case of:\n\n* any new message creation;\n* any message change in extension message store.\n\n\nThe updated message info is accessible by calling the Get Message List method.\n\n**Please note:** To receive notifications on a certain message type (Fax/Voicemail/Pager/SMS) and/or direction (Inbound/Outbound) the following event filter should be specified `/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store?type={type}&direction={direction}`. \n\n*For example* to recieve notifications on outbound fax event use the filter: `/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store?type=Fax&direction=Outbound`\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadMessages` | Viewing user messages |\n\n**Notification Payload Structure**\n\nThe client receives messages notifications payload as JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event`\t| string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Message Event | Notification payload body |\n\n**Message Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `accountId` | string | Internal identifier of an account. Optional parameter |\n| `extensionId` | string | Internal identifier of an extension. Optional parameter |\n| `lastUpdated` | datetime | Datetime when the message was last modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `changes` | Message Changes | Message changes |\n\n**Message Changes**\n\n| Parameter\t| Type | Description |\n|-----------|------|-------------|\n| `type` | 'Voicemail' or 'SMS' or 'Fax' or 'Pager' | Message type |\n| `newCount` | integer | The number of new messages. Can be omitted if the value is zero |\n| `updatedCount` | integer | The number of updated messages. Can be omitted if the value is zero |\n\n**Example**\n\n```HTTP\n{\n \"timestamp\": \"2014-04-29T14:29:27.408+0000\",\n \"uuid\": \"b11c9430-9687-4498-b12b-3fcb470bfe04\",\n \"event\": \"/restapi/v1.0/account/~/extension/406149828004/message-store\",\n \"ownerId\": \"406149828004\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"body\": {\n \"accountId\": 406149828004,\n \"extensionId\": 406149828004, \n \"lastUpdated\": \"2014-04-29T14:29:20.531+0000\",\n \"changes\": [\n {\n \"type\": \"Pager\",\n \"updatedCount\": 1,\n \"newCount\": 0\n }\n {\n \"type\": \"SMS\",\n \"updatedCount\": 0,\n \"newCount\": 1\n },\n {...} ], \n }, \n\n }\n ```\n\n\n"},{"title":"Voicemail Message Event","description":"\n*Since 1.0.36 (Release 10.2)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail` enables notifications in case of new voicemail message is received.\n\nThe updated message info is accessible by calling the Get Message List method.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadMessages` | Viewing user messages |\n\n**Notification Payload Structure**\n \nThe client receives messages notifications payload as JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId`\t| string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2018-03-10T18:07:52.534Z* |\n| `body` | Voicemail Message Event | Notification payload body |\n\n**Voicemail Message Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message |\n| `to` | Collection of Recipient Info | Message receiver(s) information |\n| `from` | Sender Info | Message sender information |\n| `type` | string | Type of a message. The value is 'Voicemail' |\n| `creationTime` | datetime | Message creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `lastModifiedTime` | datetime | Datetime when the message was modified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `readStatus` | string | Status of a message. The default value is 'Unread' |\n| `priority` | string | The default value is 'Normal' |\n| `attachments` | Collection of Instant Message Attachment Info | Message attachment data |\n| `direction` | string | Message direction. The default value is 'Inbound' |\n| `availability` | string | Message availability status. The default value is 'Alive' |\n| `subject` | string | Message subject. It replicates message text which is also returned as an attachment |\n| `messageStatus` | string | Status of a message. The default value is 'Received' |\n| `conversationId` | string | Internal identifier of a conversation this message belongs to |\n| `vmTranscriptionStatus`| string | Specifies if a voicemail message transcription is already completed or not|\n\n**Recipient Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `target` | boolean | 'True' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Sender Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `phoneNumber` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format |\n| `extensionNumber` | string | Extension number |\n| `location` | string | Contains party location (city, state), if any |\n| `name` | string | Symbolic name associated with a caller/callee |\n\n**Voicemail Message Attachment Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of a message attachment |\n| `uri` | string | Link to an attachment resource |\n| `size` | integer | Attachment size in bytes |\n| `type` | 'AudioRecording' or 'AudioTranscription'| Type of a message attachment |\n| `contentType` | string | Content type of an attachment, see also MIME Types |\n| vmDuration | integer | Duration of a voicemail in seconds |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659bb9f77e0\",\n \"event\": \"/restapi/v1.0/account/~/extension/823476228762/voicemail\",\n \"subscriptionId\": \"dc853541-66ac-45d8-a289-1a239fd72888\", \n \"ownerId\": \"823476228762\",\n \"timestamp\": \"2018-02-28T10:06:15.000Z\",\n \"body\": {\n \"id\" : 82063400004,\n \"to\" : [ {\n \"name\" : \"John Doe\"\n } ],\n \"from\" : {\n \"phoneNumber\" : \"+18664320079\",\n \"name\" : \"Jane Doe\"\n },\n \"type\" : \"VoiceMail\",\n \"creationTime\" : \"2018-02-28T10:05:55.000Z\",\n \"readStatus\" : \"Unread\",\n \"priority\" : \"Normal\",\n \"attachments\" : [ {\n \"id\" : 82063400004,\n \"uri\" : \"https://platform.ringcentral.com/restapi/v1.0/account/14833636004/extension/14833636004/message-store/82063400004/content/82063400004\",\n \"type\" : \"AudioRecording\",\n \"contentType\" : \"audio/x-wav\",\n \"vmDuration\" : 3\n } ],\n \"direction\" : \"Inbound\",\n \"availability\" : \"Alive\",\n \"messageStatus\" : \"Received\",\n \"lastModifiedTime\" : \"2018-02-28T10:06:05.000Z\",\n \"vmTranscriptionStatus\" : \"Completed\"\n }\n}\n ``` \n\n"},{"title":"Emergency Address Event","description":"\n*Since 1.0.43 (Release 20.2)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/device/{deviceId}/emergency-address` enables notifications in case of change of device emergency address.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number |\n\n**Notification Payload Structure**\n \nThe client receives emergency address notifications payload as a JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2018-03-10T18:07:52.534Z* |\n| `body` | Emergency Address Event | Notification payload body |\n\n**Emergency Address Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `deviceId` | string | Internal identifier of a device |\n\n\n**Example**\n\n```HTTP\n{ \n \"uuid\":\"ed1cf00c-0420-4bf5-a0ae-e659cc9f77e0\",\n \"event\":\"/restapi/v1.0/account/~/device/8475874957/emergency-address\",\n \"timestamp\": \"2020-01-14T12:00:00.000Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": 12311555413,\n \"body\":{ \n \"extensionId\": 12311555413,\n \"deviceId\": 8475874957\n }\n}\n ``` \n\n"},{"title":"Contact Center Phone Number Event","description":"\n*Since 1.0.43 (Release 20.2)*\n\nEvent filter `/restapi/v1.0/account/{accountId}/phone-number?usageType=ContactCenterNumber` enables notifications in case of any change related to Contact Center phone numbers. A change can be defined by the `usageType` filter with the following values: \n*Created* - a new phone number is created its first assignment is \"Contact Center\";\n*Deleted* - a Contact Center number is deleted;\n*Updated* - the existing phone number (already assigned to any extension type) was converted to \"Contact Center\"; the existing phone number of 'Contact Center' type is reassigned to any other extension type.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number |\n\n**Notification Payload Structure**\n \nThe client receives contact center numbers notifications payload as a JSON object with the following structure:\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2018-03-10T18:07:52.534Z* |\n| `body` | Contact Center Phone Number Event | Notification payload body |\n\n**Contact Center Phone Number Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `eventType` | 'Created' or 'Updated' or 'Deleted' | Type of change |\n| `phoneNumberInfo` | Phone Number Info | Information on a changed phone number |\n\n**Phone Number Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uri` | string | Link to a phone number resource |\n| `id` | string | Internal identifier of a phone number |\n| `phoneNumber` | string | Phone number in e.164 format |\n| `paymentType` | string | Type of payment |\n| `location` | string | Phone number location |\n| `type` | 'Voice' or 'Fax' or 'VoiceFax' | Type of a number |\n| `usageType` | 'ContactCenterNumber' | Phone number usage type |\n| `status` | string | Phone number status |\n| `contactCenterProvider` | Contact Center Provider Info | Information on a Contact Center Provider |\n\n\n**Contact Center Provider Info**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Internal identifier of provider|\n| `name` | string | Provider name |\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"ed1cf00c-0420-4bf5-a0ae-e659cc9f77e0\",\n \"event\": \"/restapi/v1.0/account/{accountId}/phone-number?usageType=ContactCenterNumber\",\n \"timestamp\": \"2013-06-14T12:00:00.000Z\",\n \"subscriptionId\": \"9d38419f-645f-4ee3-a053-8cf1368c21c4\",\n \"ownerId\": 8475874957,\n \"body\": {\n \"eventType\": \"Created\",\n \"phoneNumberInfo\": {\n \"uri\": \"https://platform.ringcentral.com/restapi/v1.0/account/37439510/phone-number/987654321\",\n \"id\": 987654321,\n \"phoneNumber\": \"+12024999741\",\n \"paymentType\": \"Local\",\n \"location\": \"Washington, DC\",\n \"type\": \"VoiceFax\",\n \"usageType\": \"ContactCenterNumber\",\n \"status\": \"Normal\",\n \"contactCenterProvider\": {\n \"id\": \"12345\",\n \"name\": \"ProviderName\"\n }\n }\n }\n}\n```\n\n"},{"title":"Message Batch Event","description":" \n*Since 1.0.45 (Release 20.4)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/a2p-sms/batch` enables notifications in case of any message batch change on the current account.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Query Parameters**\n\n| Parameter | Type | Description |\n|---------------|--------------------|\n| `from` | string | Notification is received if the message batch is sent from a specific number in E.164 format, e.g. +16505550100|\n\n**Notification Payload Structure**\n \nThe client receives message batch notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Message Batch Event | Notification payload body |\n\n**Message Batch Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Unique identifier of the message batch |\n| `from` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent |\n| `batchSize` | integer | Total number of messages in the accepted batch |\n| `processedCount` | integer | Total number of messages currently processed in the batch |\n| `lastModifiedTime` | string | Last time the batch was processed |\n| `status` | 'Processing' or 'Completed' | Current status of a message batch |\n| `creationTime` | string | The time at which the batch was created |\n\n\n**Example**\n\n```HTTP\n\n\n```\n\n"},{"title":"Specific Message Batch Event","description":" \n*Since 1.0.45 (Release 20.4)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/a2p-sms/batch/{batchId}` enables notifications in case of specific message batch change.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n\n\n**Notification Payload Structure**\n \nThe client receives message batch notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Specific Message Batch Event | Notification payload body |\n\n**Specific Message Batch Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Unique identifier of the message batch |\n| `from` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent |\n| `batchSize` | integer | Total number of messages in the accepted batch |\n| `processedCount` | integer | Total number of messages currently processed in the batch |\n| `lastModifiedTime` | string | Last time the batch was processed |\n| `status` | 'Processing' or 'Completed' | Current status of a message batch |\n| `creationTime` | string | The time at which the batch was created |\n\n\n**Example**\n\n```HTTP\n\n\n```\n\n"},{"title":"Batch Messages Event","description":" \n*Since 1.0.45 (Release 20.4)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/a2p-sms/messages` enables notifications in case of any message change in any batch on the current account.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Query Parameters**\n\n| Parameter | Type | Description |\n|---------------|--------------------|\n| `direction` | 'Inbound' or 'Outbound' | Specifies if notification is sent on inbound or outbound messages |\n| `batchId` | string | Notification is sent on inbound/outboud messages of the specific message batch |\n| `from` | string | Notification is sent on outbound messages from a specific phone number in E.164 format |\n| `to` | string | Notification is sent on inbound messages to a specific phone number in E.164 format |\n\n**Notification Payload Structure**\n \nThe client receives message batch notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Batch Messages Event | Notification payload body |\n\n**Batch Messages Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `id` | string | Unique identifier of the message batch |\n| `from` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are sent |\n| `to` |string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which the messages are sent |\n| `text` | string | Text of a message, maximum number of characters is 1000 |\n| `creationTime` | string | The time at which the message was created |\n| `lastModifiedTime` | string | The time when this message was last updated |\n| `messageStatus` |'Queued' or 'Delivered' or 'Sent' or 'SendingFailed' or 'DeliveryFailed' |Current status of a message |\n| `segmentCount`|integer | Number of segments of a message |\n| `cost`| number | Cost of a message |\n| `batchId` | string |The batch in which the message was submitted |\n| `direction`| 'Inbound' or 'Outbound' | Indicates whether the message is outbound or inbound |\n| `errorCode` | string | RC error code of the message sending failure reason |\n\n**Example**\n\n```HTTP\n\n\n```\n\n\n"},{"title":"Batch Message Opt-Out Event","description":" \n*Since 1.0.45 (Release 20.4)*\n \nEvent filter `/restapi/v1.0/account/~/a2p-sms/opt-outs` enables notifications in case customers opt out. \nOpt-out events are sent when a user connects to the RingCentral opt-out service using standard keywords including stop, unstop, start, etc.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n**Query Parameters**\n\n| Parameter | Type | Description |\n|---------------|--------------------|\n| `direction` | 'Inbound' or 'Outbound' | Specifies if notification is sent on inbound or outbound messages |\n| `batchId` | string | Notification is sent on inbound/outboud messages of the specific message batch |\n| `from` | string | Notification is sent on outbound messages from a specific phone number in E.164 format |\n| `to` | string | Notification is sent on inbound messages to a specific phone number in E.164 format |\n\n**Notification Payload Structure**\n \nThe client receives message batch notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | Opt-Out Event | Notification payload body |\n\n**Opt-Out Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `from` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the message is sent |\n| `to` | string | Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format to which the message is sent |\n| `active` | boolean | Indicates if opt-out service is active or not from/to the number specified|\n\n\n**Example**\n\n```HTTP\n{\n \"uuid\":\"12345678901234567890\",\n \"event\":\"/restapi/v1.0/account/11111111/a2p-sms/opt-outs\",\n \"timestamp\":\"2020-10-01T00:00:00.000Z\",\n \"subscriptionId\":\"11112222-3333-4444-5555-666677778888\",\n \"ownerId\":\"22222222\",\n \"body\":{\n \"from\":\"+16505550100\",\n \"to\":\"+12125550100\",\n \"active\":true\n }\n}\n\n```\n\n"},{"title":"Extension DND Status Event","description":"\n*Since 1.0.46 (Release 21.1)*\n \nEvent filter `/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/dnd` enables notifications in case of `dndStatus` change of the current extension.\n\n**Required Permissions**\n\n| Permission | Description |\n|----------------|-----------------------|\n| `ReadAccounts` | Viewing user account info (including name, business name, address and phone number/account number) |\n \n\n**Notification Payload Structure**\n \nThe client receives DND status change notification payload as JSON object with the following structure:\n \n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `uuid` | string | Universally unique identifier of a notification |\n| `event` | string | Event filter URI |\n| `ownerId` | string | Internal identifier of subscription owner extension |\n| `subscriptionId` | string | Internal identifier of a subscription |\n| `timestamp` | datetime | Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* |\n| `body` | DND Status Event | Notification payload body |\n\n**DND Status Event**\n\n| Parameter | Type | Description |\n|-----------|------|-------------|\n| `extensionId` | string | Internal identifier of an extension |\n| `dndStatus` | 'TakeAllCalls' or 'DoNotAcceptAnyCalls' or 'DoNotAcceptDepartmentCalls' | Extended DnD (Do not Disturb) status |\n\n**Example**\n\n```HTTP\n{\n \"uuid\": \"045b81dc-9f73-4864-84de-08aa6324a7f5\",\n \"event\": \"/restapi/v1.0/account/6610372004/extension/6610372004/presence/dnd\",\n \"timestamp\": \"2021-02-18T09:37:24.597Z\",\n \"ownerId\": \"6610372004\",\n \"body\": {\n \"extensionId\": 6610372004,\n \"dndStatus\": \"TakeAllCalls\"\n }\n }\n\n```\n"}]}],"x-introduction":[],"guideMapping":{"Using the API":"/guide/basics","Account":"/guide/account","Address Book":"/guide","Authentication":"/guide/authentication","Events & Notifications":"/guide/notifications","Team Messaging":"/guide/team-messaging","Meetings":"/guide/meetings","SMS and Fax":"/guide/messaging","Provisioning":"/guide","Utilities":"/guide","Voice":"/guide/voice"},"primaryIcons":{"Using the API":"group_icon_basics","Authentication":"group_icon_auth","Account":"group_icon_account","Address Book":"group_icon_address","Events & Notifications":"group_icon_notification","Team Messaging":"group_icon_glip","Meetings":"group_icon_meeting","SMS and Fax":"group_icon_messaging","Provisioning":"group_icon_provisioning","Utilities":"group_icon_utilities","Voice":"group_icon_voice"}}