SHOP
Cart
YateBTS logo small version

JSON API for YateHSS/HLR Control

See YateHSS/HLR

In order to configure/control PRODUCT, please use URL: http://ip-of-server-where-PRODUCT-is-installed/api.php

Request: query_stats

Retrieve node statistics for the equipment. It is mandatory to provide the desired node type.
{
    "request": "query_stats",
    "node": "hss"
}
Examples: query_stats
Get hss node status.
{
    "request": "query_stats",
    "node": "hss"
}

Request: query_cs_reg

Retrieve current Circuit Switched registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM's multi imsi) or 'imsi' (primary, alternative or multi imsi). Optionally the VLR can be queried (via ProvideSubscriberInfo) for more details.
This request has multiple formats in which it can be sent:
{
    "request": "query_cs_reg",
    "params": {
        "subscriber_id": "String. Identify registration by subscriber id",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_cs_reg",
    "params": {
        "msisdn": "String. Identify registration by MSISDN",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_cs_reg",
    "params": {
        "imsi": "String. Identify registration by IMSI",
        "query": "Boolean. Optional."
    }
}
Examples: query_cs_reg
User not registered
{
    "request": "query_cs_reg",
    "params": {
        "imsi": "1100002119922",
        "query": true
    }
}
Registred user
{
    "request": "query_cs_reg",
    "params": {
        "msisdn": "88270017",
        "query": true
    }
}

Request: query_ps_reg

Retrieve current Packet Switched registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM’s multi imsi) or 'imsi' (primary, alternative or multi imsi). Optionally the SGSN/MME can be queried (via ProvideSubscriberInfo) for more details.
This request has multiple formats in which it can be sent:
{
    "request": "query_ps_reg",
    "params": {
        "subscriber_id": "String. Identify registration by subscriber id",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_ps_reg",
    "params": {
        "msisdn": "String. Identify registration by MSISDN",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_ps_reg",
    "params": {
        "imsi": "String. Identify registration by IMSI",
        "query": "Boolean. Optional."
    }
}
Examples: query_ps_reg
Subscriber having diameter active
{
    "request": "query_ps_reg",
    "params": {
        "msisdn": "88270017",
        "query": true
    }
}
Subscriber having diameter active
{
    "request": "query_ps_reg",
    "params": {
        "msisdn": "88270017",
        "query": true
    }
}

Request: query_nontgpp_reg

Retrieve current Non-3GPP registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM’s multi imsi) or 'imsi' (primary, alternative or multi imsi).
This request has multiple formats in which it can be sent:
{
    "request": "query_nontgpp_reg",
    "params": {
        "subscriber_id": "String. Identify registration by subscriber id"
    }
}
{
    "request": "query_nontgpp_reg",
    "params": {
        "msisdn": "String. Identify registration by MSISDN"
    }
}
{
    "request": "query_nontgpp_reg",
    "params": {
        "imsi": "String. Identify registration by IMSI"
    }
}
Examples: query_nontgpp_reg
Subscriber registered on WiFi
{
    "request": "query_nontgpp_reg",
    "params": {
        "imsi": "001019901000025"
    }
}
Subscriber deregistered
{
    "request": "query_nontgpp_reg",
    "params": {
        "msisdn": "88270055"
    }
}

Request: query_ims_reg

Retrieve current IP Multimedia Subsystem registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn', 'imsi' (primary or alternative) or 'private_ident' (IMPI).
This request has multiple formats in which it can be sent:
{
    "request": "query_ims_reg",
    "params": {
        "subscriber_id": "String. Identify registration by subscriber id",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_ims_reg",
    "params": {
        "msisdn": "String. Identify registration by MSISDN",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_ims_reg",
    "params": {
        "imsi": "String. Identify registration by IMSI",
        "query": "Boolean. Optional."
    }
}
{
    "request": "query_ims_reg",
    "params": {
        "private_ident": "String. Identify registration by Private Indent",
        "query": "Boolean. Optional."
    }
}
Examples: query_ims_reg
User not registered, S-CSCF name stored (assigned)
{
    "request": "query_ims_reg",
    "params": {
        "subscriber_id": "1"
    }
}
User registered
{
    "request": "query_ims_reg",
    "params": {
        "subscriber_id": "1"
    }
}
User not registered, no S-CSCF stored
{
    "request": "query_ims_reg",
    "params": {
        "subscriber_id": "1"
    }
}

Request: query_fiveg_reg

Retrieve current 5G AMF registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM's multi imsi) or 'imsi' (primary, alternative or multi imsi).
{
    "request": "query_fiveg_reg",
    "params": {
        "comment": "Parameters used to identify the subscriber. Checked in the order listed here",
        "subscriber_id": "Conditional, string. Identify registration by subscriber id",
        "msisdn": "Conditional, string. Identify registration by MSISDN",
        "imsi": "Conditional, string. Identify registration by IMSI"
    }
}
Examples: query_fiveg_reg
User not registered
{
    "request": "query_fiveg_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}
Registred user
{
    "request": "query_fiveg_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}

Request: query_smsf_reg

Retrieve current 5G SMSF node (SMS function, used by visited network to deliver MT SMS via 5G NAS) registration status for a subscriber. The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM's multi imsi) or 'imsi' (primary, alternative or multi imsi).
{
    "request": "query_smsf_reg",
    "params": {
        "comment": "Parameters used to identify the subscriber. Checked in the order listed here",
        "subscriber_id": "Conditional, string. Identify registration by subscriber id",
        "msisdn": "Conditional, string. Identify registration by MSISDN",
        "imsi": "Conditional, string. Identify registration by IMSI"
    }
}
Examples: query_smsf_reg
User not registered
{
    "request": "query_smsf_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}
Registred user
{
    "request": "query_smsf_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}

Request: query_smf_reg

Retrieve current 5G data sessions registtered by SMF node(s). The subscriber can be identified by 'subscriber_id', 'msisdn' (assigned or set in its SIM's multi imsi) or 'imsi' (primary, alternative or multi imsi).
{
    "request": "query_smf_reg",
    "params": {
        "comment": "Parameters used to identify the subscriber. Checked in the order listed here",
        "subscriber_id": "Conditional, string. Identify registration by subscriber id",
        "msisdn": "Conditional, string. Identify registration by MSISDN",
        "imsi": "Conditional, string. Identify registration by IMSI"
    }
}
Examples: query_smf_reg
No session registered for the user
{
    "request": "query_smf_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}
Registred session(s)
{
    "request": "query_smf_reg",
    "node": "hss",
    "params": {
        "msisdn": "882809999"
    }
}
This documentation was generated on 23 September 2023

Our solutions

home subscriber server

YateHSS/HLR
HSS/HLR/AuC SIM subscribers management
See the product here ››

Write Us
Facebook-f Twitter Youtube Linkedin-in

Privacy Policy

Cookie Policy

Terms and Conditions

Returns and Refunds Policy

Copyright © SS7ware 2019

SC NULL TEAM IMPEX SRL, CUI: RO16352909
Address: Str. General Praporgescu 1-5, et 5, ap. 10, Sector 2, Bucuresti, Romania, 020965