ss7client

type ATIRequest struct {
	// Exactly one of MSISDN and IMSI (digits) identifies the subscriber.
	MSISDN string
	IMSI   string
	// Requested selects what to ask for.
	Requested RequestedInfo
	// HLRGlobalTitle and HLRPointCode address the HLR directly. Without
	// them the gateway routes on the MSISDN as global title (or uses
	// map.hlr_gt / map.hlr_pc when map.sri_routing is "hlr"); a request by
	// IMSI therefore needs one of them or map.sri_routing "hlr".
	HLRGlobalTitle string
	HLRPointCode   uint32
}

type AddressString struct {
	Digits        string `json:"digits"`
	Nature        uint8  `json:"nature"`
	NumberingPlan uint8  `json:"numbering_plan"`
}

type Authentication struct {
	DialogueID string `json:"dialogue_id,omitempty"`
	// AnswerBy (request): the gateway refuses the request with
	// systemFailure when the answer has not come by then.
	AnswerBy *time.Time `json:"answer_by,omitempty"`

	// The request (TS 29.002 §8.5.2.3).
	RequestedVectors           int    `json:"requested_vectors,omitempty"`
	RequestingNodeType         string `json:"requesting_node_type,omitempty"`
	RequestingPLMNID           string `json:"requesting_plmn_id,omitempty"` // 3 octets
	ImmediateResponsePreferred bool   `json:"immediate_response_preferred,omitempty"`
	SegmentationProhibited     bool   `json:"segmentation_prohibited,omitempty"`
	// Resynchronisation: the UE found the sequence number out of range
	// (TS 33.102 §6.3.5).
	Resynchronisation          *Resynchronisation `json:"resynchronisation,omitempty"`
	AdditionalVectors          int                `json:"additional_vectors,omitempty"`
	AdditionalVectorsAreForEPS bool               `json:"additional_vectors_are_for_eps,omitempty"`
	UEUsageTypeRequested       bool               `json:"ue_usage_type_requested,omitempty"`
	// CallingGT: the calling party's global title digits.
	CallingGT string `json:"calling_gt,omitempty"`

	// The answer: vectors, or Error.
	Triplets    []AuthenticationTriplet    `json:"triplets,omitempty"`
	Quintuplets []AuthenticationQuintuplet `json:"quintuplets,omitempty"`
	EPSVectors  []EPSVector                `json:"eps_vectors,omitempty"`
	UEUsageType string                     `json:"ue_usage_type,omitempty"` // 4 octets
	Error       int32                      `json:"error,omitempty"`
	ErrorCause  string                     `json:"error_cause,omitempty"` // a Cause* qualifying Error
	Detail      string                     `json:"detail,omitempty"`
}

type AuthenticationAnswer struct {
	Triplets    []AuthenticationTriplet
	Quintuplets []AuthenticationQuintuplet
	EPSVectors  []EPSVector
	// UEUsageType: only when Request.UEUsageTypeRequested.
	UEUsageType string
	// Reject refuses the request with one of sendAuthenticationInfo's
	// errors: MAPErrSystemFailure, MAPErrDataMissing,
	// MAPErrUnexpectedDataValue or MAPErrUnknownSubscriber.
	Reject int32
	// RejectCause qualifies a MAPErrUnknownSubscriber: CauseIMSIUnknown,
	// or CauseGPRSEPSSubscriptionUnknown when an SGSN asks for a subscriber
	// without GPRS. Optional.
	RejectCause string
}

type AuthenticationQuintuplet struct {
	RAND string `json:"rand"`
	XRES string `json:"xres"`
	CK   string `json:"ck"`
	IK   string `json:"ik"`
	AUTN string `json:"autn"`
}

type AuthenticationRequest struct {
	DialogueID string
	IMSI       string
	Request    *Authentication
	NodeID     string
	Raw        *Message
}

type AuthenticationTriplet struct {
	RAND string `json:"rand"`
	SRES string `json:"sres"`
	Kc   string `json:"kc"`
}

type BasicService struct {
	// Kind is the alternative's ASN.1 name: "ext-BearerService" or
	// "ext-Teleservice".
	Kind string `json:"kind"`
	// Code is the service code (TS 29.002 Ext-BearerServiceCode /
	// Ext-TeleserviceCode, e.g. 11 for telephony), hex.
	Code string `json:"code"`
}

type CAMELRouting struct {
	Forwarding *ForwardingData `json:"forwarding,omitempty"`
	// SubscriptionInfo is the BER encoding of GmscCamelSubscriptionInfo
	// (T-CSI, O-CSI, D-CSI and their criteria), hex, tag included.
	SubscriptionInfo string `json:"subscription_info"`
}

type CallBarringFeature struct {
	BasicService *BasicService `json:"basic_service,omitempty"`
	Status       SSStatus      `json:"status"`
}

type CallBarringInfo struct {
	SSCode   string               `json:"ss_code"`
	Features []CallBarringFeature `json:"features"`
}

type CancelLocation struct {
	LMSI string `json:"lmsi,omitempty"` // hex, 4 octets: the identity becomes imsi-WithLMSI
	// Type is the cancellationType, CancellationUpdateProcedure or
	// CancellationSubscriptionWithdraw; empty leaves it out.
	Type string `json:"type,omitempty"`
}

type CancelLocationRequest struct {
	IMSI      string // required
	VLRNumber string // required: the VLR's number, E.164 digits
	// VLRPointCode routes on DPC/SSN instead of the VLR number as GT.
	VLRPointCode uint32
	LMSI         string // hex, 4 octets
	Type         string // CancellationUpdateProcedure, CancellationSubscriptionWithdraw or ""
}

type CellGlobalID struct {
	MCC string `json:"mcc"`
	MNC string `json:"mnc"`
	LAC uint16 `json:"lac"`
	CI  uint16 `json:"ci"`
}

type Client struct {
	// contains filtered or unexported fields
}

type Direction string

type EPSVector struct {
	RAND  string `json:"rand"`
	XRES  string `json:"xres"`
	AUTN  string `json:"autn"`
	KASME string `json:"kasme"`
}

type ForwardingData struct {
	// ForwardedToNumber is the forwarded-to number (forwardedToNumber, or
	// longForwardedToNumber when the HLR sent the long form). With CAMEL
	// phase 2 an HLR may send a number that is not E.164: Nature and
	// NumberingPlan say how to read it, and non-digit TBCD values come
	// through as '*', '#', 'a', 'b', 'c'.
	ForwardedToNumber *AddressString `json:"forwarded_to_number,omitempty"`
	// ForwardedToSubaddress is the ISDN subaddress, hex.
	ForwardedToSubaddress string `json:"forwarded_to_subaddress,omitempty"`
	// Options are the ForwardingOptions, when present.
	Options *ForwardingOptions `json:"options,omitempty"`
}

type ForwardingFeature struct {
	BasicService *BasicService `json:"basic_service,omitempty"`
	Status       SSStatus      `json:"status"`
	// ForwardedToNumber goes as longForwardedToNumber when it is longer
	// than an ISDN-AddressString holds; send that only to a VLR whose
	// capability says LongFTNSupported.
	ForwardedToNumber     *AddressString     `json:"forwarded_to_number,omitempty"`
	ForwardedToSubaddress string             `json:"forwarded_to_subaddress,omitempty"` // hex
	Options               *ForwardingOptions `json:"options,omitempty"`
	// NoReplyTime is the no reply condition timer of cfnry, 5 to 30 s.
	NoReplyTime int `json:"no_reply_time,omitempty"`
}

type ForwardingInfo struct {
	SSCode   string              `json:"ss_code"`
	Features []ForwardingFeature `json:"features"`
}

type ForwardingOptions struct {
	NotifyForwardingParty   bool `json:"notify_forwarding_party,omitempty"`
	RedirectingPresentation bool `json:"redirecting_presentation,omitempty"`
	NotifyCallingParty      bool `json:"notify_calling_party,omitempty"`
	// Reason is notReachable, busy, noReply or unconditional.
	Reason string `json:"reason"`
}

type GatewayError struct {
	CorrelationID string
	Status        string // StatusTimeout, StatusAborted, ...
	Code          int32  // ErrCode* (negative) or a MAP error code (positive, MAPErr*)
	Message       string
	NodeID        string
}

type ISDRequest struct {
	IMSI      string // required
	VLRNumber string // required: E.164 digits
	// VLRPointCode routes on DPC/SSN instead of the VLR number as GT.
	VLRPointCode uint32
	Data         SubscriberData
}

type ISDResult struct {
	Result *InsertResult // never nil
	NodeID string
	Raw    *Message
}

type InsertResult struct {
	UnsupportedTeleservices   []string `json:"unsupported_teleservices,omitempty"`
	UnsupportedBearerServices []string `json:"unsupported_bearer_services,omitempty"`
	UnsupportedSSCodes        []string `json:"unsupported_ss_codes,omitempty"`
	// UnsupportedODB are the ODB-GeneralData categories it does not support.
	UnsupportedODB []string `json:"unsupported_odb,omitempty"`
	// RegionalSubscriptionResponse: networkNode-AreaRestricted,
	// tooManyZoneCodes, zoneCodesConflict or regionalSubscNotSupported.
	RegionalSubscriptionResponse string   `json:"regional_subscription_response,omitempty"`
	SupportedCAMELPhases         []int    `json:"supported_camel_phases,omitempty"`
	OfferedCAMEL4CSIs            []string `json:"offered_camel4_csis,omitempty"`
}

type Location struct {
	// AgeMinutes is the time since the last contact with the subscriber:
	// 0 = in contact now, 32767 = at least that old.
	AgeMinutes *int `json:"age_minutes,omitempty"`
	// VLRNumber and MSCNumber (CS) or SGSNNumber (PS): E.164 digits.
	VLRNumber  string `json:"vlr_number,omitempty"`
	MSCNumber  string `json:"msc_number,omitempty"`
	SGSNNumber string `json:"sgsn_number,omitempty"`
	// At most one of CellGlobalID, ServiceAreaID and LocationArea is set.
	CellGlobalID  *CellGlobalID  `json:"cell_global_id,omitempty"`
	ServiceAreaID *ServiceAreaID `json:"service_area_id,omitempty"`
	LocationArea  *LocationArea  `json:"location_area,omitempty"`
	// RoutingAreaID is the RAI value part (TS 29.060), hex. PS only.
	RoutingAreaID string `json:"routing_area_id,omitempty"`
	// LocationNumber (ITU-T Q.763), hex. CS only.
	LocationNumber string `json:"location_number,omitempty"`
	// GeographicalInformation (TS 23.032 ellipsoid point with uncertainty
	// circle, 8 octets) and GeodeticInformation (Q.763, 10 octets), hex.
	GeographicalInformation string `json:"geographical_information,omitempty"`
	GeodeticInformation     string `json:"geodetic_information,omitempty"`
	// CurrentLocationRetrieved: the location was obtained by paging just now.
	CurrentLocationRetrieved bool `json:"current_location_retrieved,omitempty"`
	// EPS is the E-UTRAN location, when the HLR returned it within the CS
	// location. CS only.
	EPS *LocationEPS `json:"eps,omitempty"`
}

type LocationArea struct {
	MCC string `json:"mcc"`
	MNC string `json:"mnc"`
	LAC uint16 `json:"lac"`
}

type LocationEPS struct {
	// ECGI and TAI as coded in TS 29.118, hex.
	ECGI string `json:"ecgi,omitempty"`
	TAI  string `json:"tai,omitempty"`
	// MMEName is the serving MME's Diameter identity.
	MMEName                  string `json:"mme_name,omitempty"`
	AgeMinutes               *int   `json:"age_minutes,omitempty"`
	GeographicalInformation  string `json:"geographical_information,omitempty"`
	GeodeticInformation      string `json:"geodetic_information,omitempty"`
	CurrentLocationRetrieved bool   `json:"current_location_retrieved,omitempty"`
}

type LocationUpdate struct {
	// DialogueID is the same in every turn of one location update. Opaque,
	// at most 64 characters.
	DialogueID string `json:"dialogue_id,omitempty"`
	Action     string `json:"action"`
	// AnswerBy is when the gateway stops waiting for the answer to a turn;
	// it then refuses the location update with systemFailure.
	AnswerBy *time.Time `json:"answer_by,omitempty"`

	// The update_location turn: what the VLR sent (UpdateLocationArg). The
	// IMSI is in Message.IMSI.
	MSCNumber     *AddressString `json:"msc_number,omitempty"`
	VLRNumber     *AddressString `json:"vlr_number,omitempty"`
	LMSI          string         `json:"lmsi,omitempty"` // hex, 4 octets
	VLRCapability *VLRCapability `json:"vlr_capability,omitempty"`
	// IMEISV is the terminal's IMEISV (16 digits), when the VLR sent it.
	IMEISV                      string `json:"imeisv,omitempty"`
	SkipSubscriberDataUpdate    bool   `json:"skip_subscriber_data_update,omitempty"`
	RestorationIndicator        bool   `json:"restoration_indicator,omitempty"`
	InformPreviousNetworkEntity bool   `json:"inform_previous_network_entity,omitempty"`
	CSLCSNotSupportedByUE       bool   `json:"cs_lcs_not_supported_by_ue,omitempty"`
	// CallingGT is the global title the VLR's request came from (SCCP
	// calling address): GSMA FS.11 screening compares it with VLRNumber.
	CallingGT string `json:"calling_gt,omitempty"`

	// Error is the MAP error of a reject answer.
	Error int32 `json:"error,omitempty"`
	// ErrorCause qualifies Error: a Cause* constant.
	ErrorCause string `json:"error_cause,omitempty"`
	// Detail says why, in an end turn or in an insert_result turn that
	// reports a failure.
	Detail string `json:"detail,omitempty"`
}

type LocationUpdateAnswer struct {
	// Insert sends the subscriber data (insertSubscriberData); the next turn
	// is its result. The gateway divides data that does not fit one message
	// into several, and gives one result.
	Insert *SubscriberData
	// Accept ends the location update with updateLocation's result, the
	// gateway's HLR number in it.
	Accept bool
	// Reject ends it with updateLocation's error: MAPErrSystemFailure,
	// MAPErrDataMissing, MAPErrUnexpectedDataValue, MAPErrUnknownSubscriber
	// or MAPErrRoamingNotAllowed.
	Reject int32
	// RejectCause qualifies the Reject: for MAPErrRoamingNotAllowed
	// CausePLMNRoamingNotAllowed (the default), CauseOperatorDeterminedBarring
	// or CauseSupportedRATTypesNotAllowed; for MAPErrUnknownSubscriber,
	// optionally, CauseIMSIUnknown or CauseGPRSEPSSubscriptionUnknown.
	RejectCause string
}

type LocationUpdateTurn struct {
	DialogueID string
	Action     string // ULUpdateLocation, ULInsertResult or ULEnd
	IMSI       string
	// Update is the VLR's request: on every turn.
	Update *LocationUpdate
	// Insert is the VLR's answer to the subscriber data (ULInsertResult
	// with an empty Status).
	Insert *InsertResult
	// Status, Code and Detail: a failure — of the subscriber data
	// (ULInsertResult: StatusRemoteError and the VLR's MAP error, or
	// StatusRejected when the gateway could not send it), or how the
	// location update ended (ULEnd: StatusAborted, StatusTimeout).
	Status string
	Code   int32
	Detail string
	NodeID string
	Raw    *Message
}

type MNPInfo struct {
	RouteingNumber string `json:"routeing_number,omitempty"`
	IMSI           string `json:"imsi,omitempty"`
	MSISDN         string `json:"msisdn,omitempty"`
	// Status is the NumberPortabilityStatus name: notKnownToBePorted,
	// ownNumberPortedOut, foreignNumberPortedToForeignNetwork,
	// ownNumberNotPortedOut, foreignNumberPortedIn.
	Status string `json:"status,omitempty"`
}

type MTRequest struct {
	IMSI                 string        // required, from SRIResult.IMSI
	NetworkNodeNumber    AddressString // required, from SRIResult.NetworkNodeNumber
	ServiceCentreAddress AddressString // required
	TPDU                 []byte        // required, SMS-DELIVER TPDU (3GPP TS 23.040), opaque to the gateway
	// MSCPointCode overrides the destination point code. Zero routes on the
	// network node number GT alone.
	MSCPointCode uint32
}

type MTResult struct {
	Status string // StatusDelivered
	NodeID string
	Raw    *Message
}

type Message struct {
	MessageID     string      `json:"message_id"`
	CorrelationID string      `json:"correlation_id,omitempty"`
	MessageType   MessageType `json:"message_type"`
	Direction     Direction   `json:"direction"`
	Timestamp     time.Time   `json:"timestamp"`

	// Addressing (E.164 digits).
	Sender    string `json:"sender,omitempty"`
	Recipient string `json:"recipient,omitempty"`
	IMSI      string `json:"imsi,omitempty"`
	MSISDN    string `json:"msisdn,omitempty"`

	// SS7 routing overrides. Zero/empty means "use the gateway's configuration".
	OPC         uint32 `json:"opc,omitempty"`
	DPC         uint32 `json:"dpc,omitempty"`
	SSN         uint8  `json:"ssn,omitempty"`
	GlobalTitle string `json:"global_title,omitempty"`

	Content     string                 `json:"content,omitempty"`
	PayloadData []byte                 `json:"payload_data,omitempty"` // base64 in JSON
	Parameters  map[string]interface{} `json:"parameters,omitempty"`

	ServiceKey uint32 `json:"service_key,omitempty"`
	EventType  string `json:"event_type,omitempty"`

	// Location interface (map.ati.*, map.psi.*): what a request asks for
	// and what the answer carries. SubscriberInfo is also in a call routing
	// answer when the HLR returns the subscriber's location or state.
	RequestedInfo  *RequestedInfo  `json:"requested_info,omitempty"`
	SubscriberInfo *SubscriberInfo `json:"subscriber_info,omitempty"`

	// Call routing (map.routing.*): the answer's routing information. The
	// answer's IMSI is in IMSI, its location and state, if any, in
	// SubscriberInfo.
	RoutingInfo *RoutingInfo `json:"routing_info,omitempty"`

	// USSD (map.ussd.*): the session, the action, and the text.
	USSD *USSD `json:"ussd,omitempty"`

	// Location management with the gateway as HLR: a location update's
	// turn or answer (map.ul); the subscriber data of an insert (map.ul
	// answer, map.isd.request) and the VLR's answer to it (map.ul turn,
	// map.isd.response); cancelLocation's and provideRoamingNumber's fields
	// (map.cl.*, map.prn.*).
	LocationUpdate       *LocationUpdate       `json:"location_update,omitempty"`
	SubscriberData       *SubscriberData       `json:"subscriber_data,omitempty"`
	InsertResult         *InsertResult         `json:"insert_result,omitempty"`
	CancelLocation       *CancelLocation       `json:"cancel_location,omitempty"`
	RoamingNumberEnquiry *RoamingNumberEnquiry `json:"roaming_number_enquiry,omitempty"`

	// Authentication and MS purging with the gateway as HLR: a
	// sendAuthenticationInfo or purgeMS and the application's answer
	// (map.sai, map.purge).
	Authentication *Authentication `json:"authentication,omitempty"`
	Purge          *Purge          `json:"purge,omitempty"`

	Status       string `json:"status,omitempty"`
	ErrorCode    int32  `json:"error_code,omitempty"`
	ErrorMessage string `json:"error_message,omitempty"`

	TraceID string `json:"trace_id,omitempty"`
	NodeID  string `json:"node_id,omitempty"` // gateway node that handled the dialogue
}

type MessageType string

type ODB struct {
	General []string `json:"general"`
	HPLMN   []string `json:"hplmn,omitempty"`
}

type Option func(*Client)

type PRNRequest struct {
	IMSI      string // required
	VLRNumber string // required: E.164 digits
	// VLRPointCode routes on DPC/SSN instead of the VLR number as GT.
	VLRPointCode uint32
	// Enquiry carries the argument; MSCNumber is required (the MSC number
	// the location update gave).
	Enquiry RoamingNumberEnquiry
}

type PRNResult struct {
	RoamingNumber             AddressString
	VMSCAddress               *AddressString
	ReleaseResourcesSupported bool
	NodeID                    string
	Raw                       *Message
}

type PSIRequest struct {
	IMSI string // required
	// VLRNumber is the serving VLR's address (required). For a combined
	// MSC/VLR it is normally the network node number SendRoutingInfoForSM
	// returned.
	VLRNumber AddressString
	// Requested selects what to ask for. MNP is not available here.
	Requested RequestedInfo
	// VLRPointCode routes on point code instead of the VLR number GT.
	VLRPointCode uint32
}

type Purge struct {
	DialogueID string     `json:"dialogue_id,omitempty"`
	AnswerBy   *time.Time `json:"answer_by,omitempty"`

	// The request: the VLR's number when a VLR sends it, the SGSN's when
	// an SGSN does.
	VLRNumber  *AddressString `json:"vlr_number,omitempty"`
	SGSNNumber *AddressString `json:"sgsn_number,omitempty"`
	CallingGT  string         `json:"calling_gt,omitempty"`

	// The answer: what to freeze (TS 29.002 §8.1.6.3 — the TMSI when the
	// VLR number is the one stored, the P-TMSI likewise for the SGSN), or
	// Error.
	FreezeTMSI  bool   `json:"freeze_tmsi,omitempty"`
	FreezePTMSI bool   `json:"freeze_ptmsi,omitempty"`
	FreezeMTMSI bool   `json:"freeze_mtmsi,omitempty"`
	Error       int32  `json:"error,omitempty"`
	ErrorCause  string `json:"error_cause,omitempty"` // a Cause* qualifying Error
	Detail      string `json:"detail,omitempty"`
}

type PurgeAnswer struct {
	FreezeTMSI, FreezePTMSI, FreezeMTMSI bool
	// Reject refuses the request with one of purgeMS's errors:
	// MAPErrDataMissing, MAPErrUnexpectedDataValue or
	// MAPErrUnknownSubscriber.
	Reject int32
	// RejectCause qualifies a MAPErrUnknownSubscriber: CauseIMSIUnknown or
	// CauseGPRSEPSSubscriptionUnknown. Optional.
	RejectCause string
}

type PurgeRequest struct {
	DialogueID string
	IMSI       string
	Request    *Purge
	NodeID     string
	Raw        *Message
}

type RequestedInfo struct {
	// Location asks for the location information of Domain.
	Location bool `json:"location,omitempty"`
	// CurrentLocation asks the serving node to page the subscriber for an
	// up-to-date location instead of the last known one. Requires Location.
	CurrentLocation bool `json:"current_location,omitempty"`
	// EPSLocation tells the HLR that the E-UTRAN location may be returned,
	// in Location.EPS or in SubscriberInfo.LocationEPS. Requires Location.
	EPSLocation bool `json:"eps_location,omitempty"`
	// State asks for the subscriber state of Domain.
	State bool `json:"state,omitempty"`
	// Domain is DomainCS (the default when empty) or DomainPS.
	Domain string `json:"domain,omitempty"`
	// IMEI asks for the equipment identity.
	IMEI bool `json:"imei,omitempty"`
	// MSClassmark asks for MS Classmark 2, returned for the CS domain.
	MSClassmark bool `json:"ms_classmark,omitempty"`
	// MNP asks for number portability information. AnyTimeInterrogation only.
	MNP bool `json:"mnp,omitempty"`
}

type Resynchronisation struct {
	RAND string `json:"rand"`
	AUTS string `json:"auts"`
}

type RoamingNumberEnquiry struct {
	// Request (ProvideRoamingNumberArg). The IMSI is in Message.IMSI.
	MSCNumber                 *AddressString `json:"msc_number,omitempty"`
	MSISDN                    *AddressString `json:"msisdn,omitempty"`
	LMSI                      string         `json:"lmsi,omitempty"` // hex, 4 octets
	GMSCAddress               *AddressString `json:"gmsc_address,omitempty"`
	CallReferenceNumber       string         `json:"call_reference_number,omitempty"` // hex, 1..8 octets
	ORInterrogation           bool           `json:"or_interrogation,omitempty"`
	SuppressionOfAnnouncement bool           `json:"suppression_of_announcement,omitempty"`
	// BearerCapability is gsm-BearerCapability: the ExternalSignalInfo
	// protocol (1 gsm-0408, 2 gsm-0806, 3 gsm-BSSMAP, 4 ets-300102-1) and
	// signal octets, hex.
	BearerCapability *SignalInfo `json:"bearer_capability,omitempty"`

	// Answer (ProvideRoamingNumberRes).
	RoamingNumber             *AddressString `json:"roaming_number,omitempty"`
	VMSCAddress               *AddressString `json:"vmsc_address,omitempty"`
	ReleaseResourcesSupported bool           `json:"release_resources_supported,omitempty"`
}

type RoutingInfo struct {
	// RoamingNumber is the MSRN to route the call on. From a number
	// portability database it is the routing number followed by the MSISDN,
	// or the MSISDN alone.
	RoamingNumber *AddressString `json:"roaming_number,omitempty"`
	// Forwarding: the call is to be forwarded.
	Forwarding *ForwardingData `json:"forwarding,omitempty"`
	// CAMEL: the subscriber has terminating CAMEL services the GMSC is to
	// invoke before routing. The gateway does not ask for them (it does not
	// offer CAMEL support in the request), so an HLR should not return this.
	CAMEL *CAMELRouting `json:"camel,omitempty"`
	// VMSCAddress is the E.164 address of the MSC serving the subscriber,
	// digits only (as Location.VLRNumber).
	VMSCAddress string `json:"vmsc_address,omitempty"`
	// MSISDN is the subscriber's basic MSISDN, when the HLR returns it.
	MSISDN string `json:"msisdn,omitempty"`
	// ForwardingInterrogationRequired: the HLR asks the GMSC to interrogate
	// it again, for forwarding, if the call is later forwarded.
	ForwardingInterrogationRequired bool `json:"forwarding_interrogation_required,omitempty"`
	// NumberPortabilityStatus is the TS 29.002 NumberPortabilityStatus name:
	// notKnownToBePorted, ownNumberPortedOut or foreignNumberPortedToForeignNetwork.
	NumberPortabilityStatus string `json:"number_portability_status,omitempty"`
	// BasicService is the service the HLR resolved the call to.
	BasicService *BasicService `json:"basic_service,omitempty"`
	// SSCodes are the supplementary services active for the call (TS 29.002
	// SS-Code, one octet each), hex.
	SSCodes []string `json:"ss_codes,omitempty"`
}

type RoutingRequest struct {
	MSISDN string // required, E.164 digits
	// HLRGlobalTitle and HLRPointCode address the HLR directly. Without
	// them the gateway routes on the MSISDN as global title (or uses
	// map.hlr_gt / map.hlr_pc when map.sri_routing is "hlr").
	HLRGlobalTitle string
	HLRPointCode   uint32
}

type RoutingResult struct {
	IMSI    string       // the subscriber's IMSI; empty if the HLR left it out
	Routing *RoutingInfo // never nil
	// SubscriberInfo is the location and state the HLR returned, if any.
	SubscriberInfo *SubscriberInfo
	NodeID         string // gateway node that ran the dialogue
	Raw            *Message
}

type SRIRequest struct {
	MSISDN               string        // required, E.164 digits
	ServiceCentreAddress AddressString // required
	// HLRGlobalTitle and HLRPointCode override the gateway's map.hlr_gt and
	// map.hlr_pc for this request. Leave empty to use the configuration.
	HLRGlobalTitle string
	HLRPointCode   uint32
}

type SRIResult struct {
	IMSI string
	// NetworkNodeNumber is the serving MSC/VLR address digits; pass it to
	// MTRequest.NetworkNodeNumber.
	NetworkNodeNumber string
	NodeID            string // gateway node that ran the dialogue
	Raw               *Message
}

type SSData struct {
	SSCode string   `json:"ss_code"`
	Status SSStatus `json:"status"`
	// CLIRestriction is clir's option: permanent, temporaryDefaultRestricted
	// or temporaryDefaultAllowed. OverrideCategory (overrideEnabled or
	// overrideDisabled) is the alternative: at most one of them.
	CLIRestriction   string         `json:"cli_restriction,omitempty"`
	OverrideCategory string         `json:"override_category,omitempty"`
	BasicServices    []BasicService `json:"basic_services,omitempty"`
}

type SSStatus struct {
	Provisioned bool `json:"provisioned,omitempty"` // P
	Registered  bool `json:"registered,omitempty"`  // R
	Active      bool `json:"active,omitempty"`      // A
	Quiescent   bool `json:"quiescent,omitempty"`   // Q
}

type ServiceAreaID struct {
	MCC string `json:"mcc"`
	MNC string `json:"mnc"`
	LAC uint16 `json:"lac"`
	SAC uint16 `json:"sac"`
}

type SignalInfo struct {
	ProtocolID int    `json:"protocol_id"`
	Data       string `json:"data"` // hex, 1..200 octets
}

type SubscriberData struct {
	MSISDN *AddressString `json:"msisdn,omitempty"`
	// Category is the ITU-T Q.763 calling party's category, hex (0a:
	// ordinary subscriber).
	Category string `json:"category,omitempty"`
	// SubscriberStatus is serviceGranted or operatorDeterminedBarring (then
	// ODB is required).
	SubscriberStatus string `json:"subscriber_status,omitempty"`
	// BearerServices and Teleservices are Ext-BearerServiceCode and
	// Ext-TeleserviceCode values, hex (11: telephony, 21:
	// shortMessageMT-PP, 22: shortMessageMO-PP).
	BearerServices []string          `json:"bearer_services,omitempty"`
	Teleservices   []string          `json:"teleservices,omitempty"`
	Forwarding     []ForwardingInfo  `json:"forwarding,omitempty"`
	CallBarring    []CallBarringInfo `json:"call_barring,omitempty"`
	SSData         []SSData          `json:"ss_data,omitempty"`
	ODB            *ODB              `json:"odb,omitempty"`
	// RoamingRestrictedUnsupportedFeature is
	// roamingRestrictionDueToUnsupportedFeature.
	RoamingRestrictedUnsupportedFeature bool `json:"roaming_restricted_unsupported_feature,omitempty"`
	// RegionalSubscription are zone codes (TS 23.003 §4.4), hex, 2 octets
	// each; at most 10.
	RegionalSubscription []string `json:"regional_subscription,omitempty"`
	// NetworkAccessMode is packetAndCircuit, onlyCircuit or onlyPacket.
	NetworkAccessMode string `json:"network_access_mode,omitempty"`
	// AccessRestriction are AccessRestrictionData names: utranNotAllowed,
	// geranNotAllowed, ganNotAllowed, i-hspa-evolutionNotAllowed,
	// wb-e-utranNotAllowed, ho-toNon3GPP-AccessNotAllowed,
	// nb-iotNotAllowed, enhancedCoverageNotAllowed.
	AccessRestriction []string `json:"access_restriction,omitempty"`
}

type SubscriberInfo struct {
	// Location is the circuit-switched location (MSC/VLR).
	Location *Location `json:"location,omitempty"`
	// State is the circuit-switched subscriber state.
	State *SubscriberState `json:"state,omitempty"`
	// LocationGPRS is the packet-switched location (SGSN).
	LocationGPRS *Location `json:"location_gprs,omitempty"`
	// PSState is the packet-switched subscriber state.
	PSState *SubscriberState `json:"ps_state,omitempty"`
	// EPSState is the EPS subscriber state.
	EPSState *SubscriberState `json:"eps_state,omitempty"`
	// LocationEPS is the EPS location returned outside Location.
	LocationEPS *LocationEPS `json:"location_eps,omitempty"`
	// IMEI digits (TS 23.003), 15 or 16 of them.
	IMEI string `json:"imei,omitempty"`
	// MSClassmark2 is the value part of the MS Classmark 2 IE (TS 24.008), hex.
	MSClassmark2 string `json:"ms_classmark2,omitempty"`
	// MNP is the number portability information.
	MNP *MNPInfo `json:"mnp,omitempty"`
}

type SubscriberInfoResult struct {
	Info   *SubscriberInfo // never nil
	NodeID string          // gateway node that ran the dialogue
	Raw    *Message
}

type SubscriberState struct {
	State              string `json:"state"`
	NotReachableReason string `json:"not_reachable_reason,omitempty"`
}

type SuperCharger struct {
	SendSubscriberData bool   `json:"send_subscriber_data,omitempty"`
	SubscriberDataAge  string `json:"subscriber_data_age,omitempty"`
}

type USSD struct {
	SessionID string `json:"session_id,omitempty"`
	Action    string `json:"action"`
	// Route is the route a session belongs to (events, and a start that
	// names one).
	Route string `json:"route,omitempty"`
	// DCS and Data are the USSD data coding scheme (TS 23.038 §5) and the
	// USSD-String (base64 in JSON). An answer without them is an empty
	// reply, which unstructuredSS-Request allows.
	DCS  *byte  `json:"dcs,omitempty"`
	Data []byte `json:"data,omitempty"`
	// Text is Data decoded, when the DCS is GSM 7-bit or UCS2. A language
	// indication the DCS announces (0x10, 0x11) stays at its start. In a
	// command, Text alone asks the gateway to encode it (GSM 7-bit when
	// every character is in the default alphabet, else UCS2).
	Text string `json:"text,omitempty"`
	// Error is the MAP error of a reject command.
	Error int32 `json:"error,omitempty"`
	// Detail says who released a session, in an end event; in a begin, why
	// Text is missing when the string could not be decoded.
	Detail string `json:"detail,omitempty"`
}

type USSDAnswer struct {
	SessionID string
	Reply     *USSDMessage // nil for a notify
	NodeID    string
	Raw       *Message
}

type USSDEvent struct {
	SessionID string
	Action    string // USSDBegin or USSDEnd
	Route     string
	// Begin: the subscriber — the IMSI or MSISDN of the HLR's destination
	// reference, the MSISDN of its argument; either may be missing — and
	// what they sent.
	MSISDN, IMSI string
	Message      *USSDMessage
	// End: how (see Endings).
	Status string
	Code   int32
	Detail string
	NodeID string
	Raw    *Message
}

type USSDMessage struct {
	// Empty: the reply carried no USSD string.
	Empty bool
	DCS   byte
	Data  []byte
	// Text is Data decoded; empty when the DCS is not GSM 7-bit or UCS2.
	Text string
}

type USSDStart struct {
	// Exactly one of MSISDN and IMSI (digits) identifies the subscriber. The
	// HLR is addressed by the MSISDN as global title, or by map.hlr_gt /
	// map.hlr_pc (map.sri_routing "hlr"); a start by IMSI needs the latter.
	MSISDN, IMSI string
	// Notify sends unstructuredSS-Notify instead of unstructuredSS-Request.
	Notify  bool
	Message USSDText
	// Route receives the session's end event; USSDDefaultRoute when empty.
	Route string
}

type USSDText struct {
	Text string
	DCS  *byte
	Data []byte
}

type VLRCapability struct {
	// SupportedCAMELPhases are the CAMEL phase numbers, 1 to 4.
	SupportedCAMELPhases []int `json:"supported_camel_phases,omitempty"`
	// OfferedCAMEL4CSIs are the ASN.1 names: o-csi, d-csi, vt-csi, t-csi,
	// mt-sms-csi, mg-csi, psi-enhancements.
	OfferedCAMEL4CSIs []string `json:"offered_camel4_csis,omitempty"`
	// SupportedRATTypes are the ASN.1 names: utran, geran, gan,
	// i-hspa-evolution, e-utran, nb-iot.
	SupportedRATTypes []string `json:"supported_rat_types,omitempty"`
	// SupportedLCSCapabilitySets are the set numbers, 1 to 5.
	SupportedLCSCapabilitySets   []int `json:"supported_lcs_capability_sets,omitempty"`
	LongFTNSupported             bool  `json:"long_ftn_supported,omitempty"`
	MSISDNLessOperationSupported bool  `json:"msisdn_less_operation_supported,omitempty"`
	MTRoamingForwardingSupported bool  `json:"mt_roaming_forwarding_supported,omitempty"`
	SOLSASupported               bool  `json:"solsa_supported,omitempty"`
	LongGroupIDSupported         bool  `json:"long_group_id_supported,omitempty"`
	ResetIDsSupported            bool  `json:"reset_ids_supported,omitempty"`
	// ISTSupport is basicISTSupported or istCommandSupported.
	ISTSupport string `json:"ist_support,omitempty"`
	// SuperCharger is the VLR's Super-Charger information (TS 23.116).
	SuperCharger *SuperCharger `json:"super_charger,omitempty"`
}