Querying an SMS 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}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
version	Yes	String	The version information. Minimum length: 1 character Maximum length: 10 characters

Request

None

Response

Status code: 200

**Table 2** Response body parameters
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
status	String	The version status. SUPPORTED indicates that the version is supported. Minimum length: 0 characters Maximum length: 255 characters
updated	String	The time when the version was 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 time. For example, 2018-09-30T00:00:00Z Minimum length: 0 characters Maximum length: 255 characters

**Table 3** Link
Parameter	Type	Description
href	String	The API URL. Minimum length: 0 characters Maximum length: 1,024 characters
rel	String	The 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://{endpoint}/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}

Example Response

Status code: 200

The information about the specified API version was obtained.

{
  "links" : [ {
    "rel" : "self",
    "href" : "https://{endpoint}/v3"
  } ],
  "id" : "v3",
  "updated" : "2020-09-02T17:50:00Z",
  "status" : "SUPPORTED"
}