Listing SMS API Versions

Function

This API is used to list SMS API versions.

Calling Method

For details, see Calling APIs.

URI

GET /

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
versions	Array of Version objects	The list of all SMS API versions. Array Length: 0 - 1024

**Table 3** Version
Parameter	Type	Description
id	String	The API version. Minimum: 0 Maximum: 255
links	Array of Link objects	The API link address. Array Length: 0 - 1024
status	String	The version status. SUPPORTED indicates that the version is supported. Minimum: 0 Maximum: 255
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 Coordinated Universal Time (UTC). For example, 2018-09-30T00:00:00Z Minimum: 0 Maximum: 255

**Table 4** Link
Parameter	Type	Description
href	String	The API URL. Minimum: 0 Maximum: 1024
rel	String	Its value is self, indicating that href is a local link. Minimum: 0 Maximum: 1024

Example Requests

This example queries the list of supported API versions.

GET https://{endpoint}/

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

Example Responses

Status code: 200

The list of supported API versions was obtained.

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