该接口用于查询物联网卡的在线状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetCardRealStatus

系统规定参数。取值:GetCardRealStatus

Iccid String 89860321******15668

物联网卡的ICCID。

您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面查看ICCID。

Msisdn String 144******1111

物联网卡的MSISDN。

SerialNo Array of String 4f84******7895

轮询查询结果的唯一标识。

说明:

1、因该接口运营商能力较弱,查询结果需时,故结合轮询能力使用。

2、在首次请求后,如Status未成功,则返回参数中会带此数据,再用此数据进行结果轮询。

返回数据

名称 类型 示例值 描述
RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

请求ID,阿里云为该请求生成的标识符。

Success Boolean true

是否调用成功。

true:调用成功。 false:调用失败。

Code String 200

接口返回码。

200:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

ErrorMessage String InstanceId cannot be empty.

调用失败时,返回的错误信息。

LocalizedMessage String InstanceId cannot be empty.

根据当前所在地展示对应语言的错误提示。

Data Array of CarriersVO

返回数据。

SerialNo String 4f84******7895

轮询查询结果的唯一标识。

说明:

1、因该接口运营商能力较弱,查询结果需时,故结合轮询能力使用。

2、在首次请求后,如Status未成功,则返回参数中会带此数据,再用此数据进行结果轮询。

Iccid String 89860321******15668

卡的ICCID,当请求ICCID为多网卡主卡时,此处返回子卡ICCID。

Gprs Boolean true

网络服务状态。

true:开通。

false:关闭。

Online Boolean true

在线状态。

true:在线。

false:不在线。

Status String SUCCESS

查询结果状态:

SUCCESS:成功

FAILURE:失败

PROCESSING

示例

请求示例

http(s)://[Endpoint]/?Action=GetCardRealStatus
&Iccid=89860321******15668
&Msisdn=144******1111
&SerialNo=["4f84b7a5-90******07895"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetCardRealStatusResponse>
    <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>
    <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>
    <Data>
        <SerialNo>4f84b7a5-90******07895</SerialNo>
        <Iccid>89860321******15668</Iccid>
        <Gprs>true</Gprs>
        <Online>true</Online>
        <Status>SUCCESS</Status>
    </Data>
</GetCardRealStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E4F94B97-1D64-4080-BFD2-67461667AA43",
  "Success" : true,
  "Code" : "200",
  "ErrorMessage" : "InstanceId cannot be empty.",
  "LocalizedMessage" : "InstanceId cannot be empty.",
  "Data" : [ {
    "SerialNo" : "4f84b7a5-90******07895",
    "Iccid" : "89860321******15668",
    "Gprs" : true,
    "Online" : true,
    "Status" : "SUCCESS"
  } ]
}