該接口用于查詢物聯網卡的在線狀態。

調試

您可以在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"
  } ]
}