JSON API for Subscriber Management

From YateBTS
Revision as of 16:24, 13 July 2015 by Gratiela.dumitrica (Talk | contribs) (Created page with " == Request: '''set_subscriber''' == { subscriber_id: active: 0/1 msisdn: , plmn_allowed: , identities: [ { username: password: ha1: a...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Request: set_subscriber

{  subscriber_id:
   active: 0/1
   msisdn: ,
   plmn_allowed: ,
   
   identities: [
	{ username:
	   password:
	   ha1:
	   auth: Digest-AKAv1-MD5/ EAP_SIM/..
	},
	{ imsi:
	   ki:  // this can be set for only one identity, the other identities can have different IMSIs, but they use the same ki
	   op:
	   opc:
	   sim_type: 2G/3G/4G
  	},
   ]  
}

Request: get_subscriber

This request has multiple uses:

{} -- retrieve subscriber count
{ limit: , offset: }  --  
{ subscriber_id: }  -- retrieve specific subscriber
{imsi: , msisdn: , status:registered/not registered/without MSISDN} -- optional filters

Request: set_suplimentary_services

This parameters can be set in this request or can be set directly with set_subscriber request.

{ subscriber_id:
  cfu:
  cfb:
  cfnrc:
  cfnry:
  cfnry_time:
  clir:
  baoc:
  boic:
  cw: 
  hold:
  multiPTY:
}

Request: get_suplimentary_services

{ subscriber_id: }

Request: set_pdn

{  subscriber_id:
   pdn_id:                // not null default 1
   pdn_type:  ipv6/.. ,
   pdn_apn_ni:        // not null 
   pdn_default:       |// not null default 0
   pdn_useraddr_v4: 
   pdn_useraddr_v6: 
   pdn_qci:        // not null default 5
   pdn_qci_prio:   // not null default 15
   pdn_ambr_uplink:  // not null default 0
   pdn_ambr_downlink:  // not null default 0
   pdn_pgwaddr_v4: 
   pdn_pgwaddr_v6:
   pdn_pgw_realm:
   pdn_pgw_host:
}

Request: get_pdn

{  subscriber_id: ,
   pdn_id:   // optional, if not specified all pdns for this subscriber will be returned
}