Querying an API Version
Function
This API is used to query a specified API version of SMS.
Calling Method
For details, see Calling APIs.
URI
GET /{version}
Parameter | Mandatory | Type | Description |
---|---|---|---|
version | Yes | String | The version information. Minimum length: 1 character Maximum length: 10 characters |
Request
None
Response
Status code: 200
Parameter | Type | Description |
---|---|---|
id | String | The API version. Minimum length: 0 characters Maximum length: 255 characters |
links | Array of Link objects | The API link address. Array length: 0 to 1,024 characters |
status | String | The version status. CURRENT indicates the recommended version. DEPRECATED indicates a deprecated version which may be deleted later Minimum length: 0 characters Maximum length: 255 characters |
updated | String | The time when the version is updated. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the UTC. Example: 2018-09-30T00:00:00Z Minimum length: 0 characters Maximum length: 255 characters |
Parameter | Type | Description |
---|---|---|
href | String | The URL of the API version. Minimum length: 0 characters Maximum length: 1,024 characters |
rel | String | Its value is self, indicating that href is a local link. Minimum length: 0 characters Maximum length: 1,024 characters |
Example Request
This example queries a specified SMS API version.
GET https://{endpoint}/v3{"links" : [ {"rel" : "self","href" : "https://sms-api.ru-moscow-1.hc.sbercloud.ru/v3"} ],"id" : "v3","updated" : "2020-09-02T17:50:00Z","status" : "SUPPORTED"}
Example Response
Status code: 200
OK
{"links" : [ {"rel" : "self","href" : "https://sms-api.ru-moscow-1.hc.sbercloud.ru/v3"} ],"id" : "v3","updated" : "2020-09-02T17:50:00Z","status" : "SUPPORTED"}
Status Codes
Status Code | Description |
---|---|
200 | Response returned. |
Error Codes
For details, see Error Codes.
- Function
- Calling Method
- URI
- Request
- Response
- Example Request
- Example Response
- Status Codes
- Error Codes