Regional Settings
List States
Returns all states of a certain country.
get/restapi/v1.0/dictionary/state
Request
- Base URLhttps://platform.ringcentral.com
- AuthOAuth 2Authorization codehttps://platform.ringcentral.com/restapi/oauth/authorizeToken URLhttps://platform.ringcentral.com/restapi/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
allCountriesboolean
If set to true then states of all countries are returned and countryId is ignored, even if specified. If the value is empty then the parameter is ignored
countryIdinteger
Internal identifier of a country
pageinteger
Indicates a page number to retrieve. Only positive number values are accepted
perPageinteger
Indicates a page size (number of items)
withPhoneNumbersboolean
If true the list of states with phone numbers available for buying is returned
Response
States list
Example response
{
"paging": {
"perPage": 50,
"page": 5,
"pageEnd": 5,
"totalPages": 25,
"totalElements": 25
}
}Changes
No recorded changes to this operation across all 1 revision of this API.