SMSC API – JSON API for YateSMSC Control

Yate-based Short Message Service Center has the functions of receiving, forwarding, storing and delivering SMSs in GSM, UMTS, LTE or custom networks. This page is presenting the SMSC JSON API requests and responses for YateSMSC control.

Request: query_stats

Retrieve statistics from a running node.
More information about this request here

Request: query_messages

Retrieve waiting messages counters for a subscriber.
The subscriber should be identified by MSISDN since this is the primary identity for a SMSC.
Identification by IMSI works only for own subscribers and not even always.
This request has multiple formats in which it can be sent:
{
    "request": "query_messages",
    "node": "smsc",
    "params": {
        "msisdn": "Mandatory, string. Phone number of the subscriber.",
        "details": "Optional, bool, default=false. Retrieve mode details about the subscriber."
    }
}
{ "request": "query_messages", "node": "smsc", "params": { "imsi": "Mandatory, string. International Mobile Subscriber Identity", "details": "Optional, bool, default=false. Retrieve mode details about the subscriber." } }
Examples: query_messages
Retrieve waiting messages counters for MSISDN '96388270078'. Short Response.
{
    "request": "query_messages",
    "node": "smsc",
    "params": {
        "msisdn": "96388270078"
    }
}
Retrieve waiting messages counters for MSISDN '96388270078'. Detailed Response.
{
    "request": "query_messages",
    "node": "smsc",
    "params": {
        "msisdn": "96388270078",
        "details": true
    }
}

Request: query_subscriber_all

Retrieve from HLR information about a subscriber using all available methods.
For each interrogation type a separate object contains returned information.
CS and PS information is retrieved via AnyTimeInterrogation while SMS information uses SendRoutingInfoForSM.
The subscriber should be identified by MSISDN since this is the primary identity for a SMSC. Identification by IMSI works only if HLR is specified or configured.
This request has multiple formats in which it can be sent:
{
    "request": "query_subscriber_all",
    "params": {
        "msisdn": "Mandatory, string. Phone Number.",
        "hlr": "Optional, string. GT of the HLR to query."
    }
}
{ "request": "query_subscriber_all", "params": { "imsi": "Mandatory, string. International Mobile Subscriber Identity.", "hlr": "Optional, string. GT of the HLR to query" } }
Examples: query_subscriber_all
Retrieve information about subscriber that has MSISDN '963888810991'.
{
    "request": "query_subscriber_all",
    "node": "smsc",
    "params": {
        "msisdn": "963888810991"
    }
}

Request: query_subscriber_sms

Retrieve from HLR information about a subscriber using SendRoutingInfoForSM.
The subscriber should be identified by MSISDN since this is the primary identity for a SMSC. Identification by IMSI works only if HLR is specified or configured.
{
    "request": "query_subscriber_sms",
    "params": {
        "msisdn": "Mandatory, string. Phone Number.",
        "imsi": "Optional, string. International Mobile Subscriber Identity.",
        "hlr": "Optional, string. GT of the HLR to query."
    }
}
Examples: query_subscriber_sms
Retrieve from HLR information about subscriber that has MSISDN '963888810991'.
{
    "request": "query_subscriber_sms",
    "node": "smsc",
    "params": {
        "msisdn": "963888810991"
    }
}

Request: query_subscriber_cs

Retrieve from HLR the CS information about a subscriber using AnyTimeInterrogation.
The subscriber should be identified by MSISDN. Identification by IMSI works only if HLR is specified or configured.
This request has multiple formats in which it can be sent:
{
    "request": "query_subscriber_cs",
    "params": {
        "msisdn": "Mandatory, string. Phone Number.",
        "hlr": "Optional, string. GT of the HLR to query."
    }
}
{ "request": "query_subscriber_cs", "params": { "imsi": "Mandatory, string. International Mobile Subscriber Identity.", "hlr": "Optional, string. GT of the HLR to query" } }
Examples: query_subscriber_cs
Retrieve from HLR the CS information about subscriber that has MSISDN '96388270078'.
{
    "request": "query_subscriber_cs",
    "node": "smsc",
    "params": {
        "msisdn": "96388270078"
    }
}

Request: query_subscriber_ps

Retrieve from HLR the PS or EPS information about a subscriber using AnyTimeInterrogation.
The subscriber should be identified by MSISDN. Identification by IMSI works only if HLR is specified or configured.
This request has multiple formats in which it can be sent:
{
    "request": "query_subscriber_ps",
    "params": {
        "msisdn": "Mandatory, string. Phone Number.",
        "hlr": "Optional, string. GT of the HLR to query."
    }
}
{ "request": "query_subscriber_ps", "params": { "imsi": "Mandatory, string. International Mobile Subscriber Identity.", "hlr": "Optional, string. GT of the HLR to query" } }
Examples: query_subscriber_ps
Retrieve from HLR the PS or EPS information about subscriber that has MSISDN '963880100'.
{
    "request": "query_subscriber_ps",
    "node": "smsc",
    "params": {
        "msisdn": "963880100"
    }
}
This documentation was generated on 29 May 2020

Our solutions