查询SIM卡实名认证信息
功能介绍
实时查询SIM卡实名认证信息,接口仅支持查询中国大陆运营商卡片的实名认证信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/sim-cards/{sim_card_id}/real-named
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sim_card_id |
是 |
Long |
SIM卡标识,如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取 最小值:0 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
iccid |
否 |
String |
iccid,传入的sim_card_id为0,则根据iccid进行处理 最小长度:19 最大长度:20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
iccid |
String |
ICCID |
real_named |
Boolean |
是否已实名认证: true表示是,false表示否。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
-
查询sim_card_id对应的SIM卡最新实名认证信息。
GET https://{endpoint}/v1/sim-cards/{sim_card_id}/real-named
-
查询SIM卡最新实名认证信息。当参数sim_card_id为最小值时,查询卡标识iccid为“8986xxxxxxxxxxxxxxx”的卡片最新实名认证信息。
GET https://{endpoint}/v1/sim-cards/{sim_card_id}/real-named { "iccid" : "898600xxxxxxxxxxxxxx" }
响应示例
状态码: 200
OK
{ "iccid" : "898600xxxxxxxxxxxxxx", "real_named" : false }
状态码: 400
Parameter Invalid
{ "error_code" : "GSL.00010004", "error_msg" : "参数异常" }
状态码: 500
Internal Server Error
{ "error_code" : "GSL.00010003", "error_msg" : "系统繁忙,请稍后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Parameter Invalid |
500 |
Internal Server Error |
错误码
请参见错误码。