Tech-invite 3GPPspace IETFspace

21 22 23 24 25 26 27 28 29 31 32 33 34 35 36 37 38 4‑5x

Content for TS 29.538 Word version: 18.0.0

1… 5…

11.1 General 11.2 Security

5 Services offered by the MSGin5G Servers p. 11

5.1 Introduction p. 11

5.2 MSGS_ASRegistration Service p. 11

5.2.1 Service Description p. 11

5.2.2 Service Operations p. 12

5.2.2.1 Introduction p. 12

5.2.2.2 MSGS_ASRegistration_Request p. 12

5.2.2.2.1 General p. 12

5.2.2.2.2 Application Server registering to MSGin5G Server using MSGS_ASRegistration_Request operation p. 12

5.2.2.3 MSGS_ASRegistration_Deregister p. 13

5.2.2.3.1 General p. 13

5.2.2.3.2 Application Server deregistering from MSGin5G Server using MSGS_ASRegistration_Deregister operation p. 13

5.3 MSGS_MSGDelivery Service p. 14

5.3.1 Service Description p. 14

5.3.2 Service Operations p. 14

5.3.2.1 Introduction p. 14

5.3.2.2 MSGS_MSGDelivery_ASODelivery p. 14

5.3.2.2.1 General p. 14

5.3.2.2.2 AS Originating MSGin5G Message Delivery p. 15

5.3.2.3 MSGS_MSGDelivery_ASODeliveryReport p. 16

5.3.2.3.1 General p. 16

5.3.2.3.2 AS Originating Message Delivery Status Report p. 16

5.3.2.4 MSGS_MSGDelivery_UEODelivery p. 16

5.3.2.4.1 General p. 16

5.3.2.4.2 UE Originating Message Delivery p. 17

5.3.2.5 MSGS_MSGDelivery_UEODeliveryReport p. 18

5.3.2.5.1 General p. 18

5.3.2.5.2 UE Originating Message Delivery Status Report p. 18

6 Services offered by the Message Gateway p. 18

6.1 Introduction p. 18

6.2 MSGG_L3GDelivery Service p. 19

6.2.1 Service Description p. 19

6.2.2 Service Operations p. 19

6.2.2.1 Introduction p. 19

6.2.2.2 MSGG_L3GDelivery_GTDelivery p. 20

6.2.2.2.1 General p. 20

6.2.2.2.2 Legacy 3GPP Message Gateway Terminating Message Delivery p. 20

6.2.2.3 MSGG_L3GDelivery_GTDeliveryReport p. 21

6.2.2.3.1 General p. 21

6.2.2.3.2 Legacy 3GPP Message Gateway Terminating Message Delivery Status Report p. 21

6.3 MSGG_N3GDelivery Service p. 21

6.3.1 Service Description p. 21

6.3.2 Service Operations p. 22

6.3.2.1 Introduction p. 22

6.3.2.2 MSGG_N3GDelivery_GTDelivery p. 22

6.3.2.2.1 General p. 22

6.3.2.2.2 Non-3GPP Message Gateway Terminating Message Delivery p. 22

6.3.2.3 MSGG_N3GDelivery_GTDeliveryReport p. 23

6.3.2.3.1 General p. 23

6.3.2.3.2 Non-3GPP Message Gateway Terminating Message Delivery Status Report p. 23

7 Common information applicable to several APIs p. 24

7.1 General p. 24

7.2 Data Types p. 24

7.2.1 General p. 24

7.2.2 Referenced structured data types p. 24

7.2.3 Referenced Simple data types and enumerations p. 24

7.3 Usage of HTTP p. 25

7.4 Content type p. 25

7.5 URI structure p. 25

7.5.1 Resource URI structure p. 25

7.5.2 Custom operations URI structure p. 25

7.6 Notifications p. 25

7.7 Error Handling p. 25

7.8 Feature negotiation p. 25

7.9 HTTP headers p. 26

7.10 Conventions for Open API specification files p. 26

8 Message Server API definition p. 26

8.1 MSGS_ASRegistration API p. 26

8.1.1 API URI p. 26

8.1.2 Resources p. 26

8.1.2.1 Overview p. 26

8.1.2.2 Resource: AS Registrations p. 27

8.1.2.2.1 Description p. 27

8.1.2.2.2 Resource Definition p. 27

8.1.2.2.3 Resource Standard Methods p. 27

8.1.2.2.3.1 POST p. 27

8.1.2.3 Resource: AS DeRegistration p. 28

8.1.2.3.1 Description p. 28

8.1.2.3.2 Resource Definition p. 28

8.1.2.3.3 Resource Standard Methods p. 28

8.1.2.3.3.1 DELETE p. 28

8.1.3 Custom Operations without associated resources p. 29

8.1.4 Notifications p. 29

8.1.5 Data Model p. 29

8.1.5.1 General p. 29

8.1.5.2 Structured data types p. 30

8.1.5.2.1 Introduction p. 30

8.1.5.2.2 Type: ASRegistration p. 30

8.1.5.2.3 Type: ASRegistrationAck p. 30

8.1.5.2.4 Type: ASProfile p. 31

8.1.5.3 Simple data types and enumerations p. 31

8.1.6 Error Handling p. 31

8.1.6.1 General |R18| p. 31

8.1.6.2 Protocol Errors |R18| p. 31

8.1.6.3 Application Errors |R18| p. 31

8.1.7 Feature negotiation p. 31

8.2 MSGS_MSGDelivery API p. 31

8.2.1 API URI p. 31

8.2.2 Resources p. 32

8.2.3 Custom Operations without associated resources p. 32

8.2.3.1 Overview p. 32

8.2.3.2 Operation: deliver-as-message p. 33

8.2.3.2.1 Description p. 33

8.2.3.2.2 Operation Definition p. 33

8.2.3.3 Operation: deliver-ue-message p. 33

8.2.3.3.1 Description p. 33

8.2.3.3.2 Operation Definition p. 33

8.2.3.4 Operation: deliver-report p. 34

8.2.3.4.1 Description p. 34

8.2.3.4.2 Operation Definition p. 34

8.2.4 Notifications p. 34

8.2.5 Data Model p. 34

8.2.5.1 General p. 34

8.2.5.2 Structured data types p. 36

8.2.5.2.1 Introduction p. 36

8.2.5.2.2 Type: ASMessageDelivery p. 36

8.2.5.2.3 Type:UEMessageDelivery p. 37

8.2.5.2.4 Type: MessageDeliveryAck p. 38

8.2.5.2.5 Type:MessageSegmentParameters p. 38

8.2.5.2.6 Type:StoreAndForwardParameters p. 38

8.2.5.2.7 Type:DeliveryStatusReport p. 39

8.2.5.3 Simple data types and enumerations p. 39

8.2.5.3.1 Introduction p. 39

8.2.5.3.2 Simple data types p. 39

8.2.5.3.3 Enumeration: DeliveryStatus p. 39

8.2.5.3.4 Enumeration: ReportDeliveryStatus p. 39

8.2.5.3.5 Enumeration:Priority p. 40

8.2.6 Error Handling p. 40

8.2.6.1 General |R18| p. 40

8.2.6.2 Protocol Errors |R18| p. 40

8.2.6.3 Application Errors |R18| p. 40

8.2.7 Feature negotiation p. 40

9 Message Gateway API definition p. 40

9.1 MSGG_L3GDelivery API p. 40

9.1.1 API URI p. 40

9.1.2 Resources p. 41

9.1.3 Custom Operations without associated resources p. 41

9.1.3.1 Overview p. 41

9.1.3.2 Operation: deliver-message p. 41

9.1.3.2.1 Description p. 41

9.1.3.2.2 Operation Definition p. 41

9.1.3.3 Operation: deliver-report p. 42

9.1.3.3.1 Description p. 42

9.1.3.3.2 Operation Definition p. 42

9.1.4 Notifications p. 42

9.1.5 Data Model p. 42

9.1.5.1 General p. 42

9.1.5.2 Structured data types p. 43

9.1.5.2.1 Introduction p. 43

9.1.5.2.2 Type: L3gMessageDelivery p. 43

9.1.5.2.3 Type: Address p. 44

9.1.5.3 Simple data types and enumerations p. 44

9.1.5.3.1 Introduction p. 44

9.1.5.3.2 Enumeration: AddressType p. 44

9.1.6 Error Handling p. 44

9.1.6.1 General |R18| p. 44

9.1.6.2 Protocol Errors |R18| p. 44

9.1.6.3 Application Errors |R18| p. 44

9.1.7 Feature negotiation p. 44

9.2 MSGG_N3GDelivery API p. 45

9.2.1 API URI p. 45

9.2.2 Resources p. 45

9.2.3 Custom Operations without associated resources p. 45

9.2.3.1 Overview p. 45

9.2.3.2 Operation: deliver-message p. 46

9.2.3.2.1 Description p. 46

9.2.3.2.2 Operation Definition p. 46

9.2.3.3 Operation: deliver-report p. 46

9.2.3.3.1 Description p. 46

9.2.3.3.2 Operation Definition p. 46

9.2.4 Notifications p. 46

9.2.5 Data Model p. 47

9.2.5.1 General p. 47

9.2.5.2 Structured data types p. 48

9.2.5.2.1 Introduction p. 48

9.2.5.2.2 Type: N3gMessageDelivery p. 48

9.2.6 Error Handling p. 48

9.2.6.1 General |R18| p. 48

9.2.6.2 Protocol Errors |R18| p. 48

9.2.6.3 Application Errors |R18| p. 49

9.2.7 Feature negotiation p. 49

10 Security p. 49

11 Using Common API Framework p. 49

11.1 General p. 49

11.2 Security p. 49

12 Usage of Network Capabilities p. 50

A (Normative) OpenAPI specification p. 51

A.1 General p. 51

A.2 MSGS_ASRegistration API p. 51

A.3 MSGS_MSGDelivery API p. 53

A.4 MSGG_L3GDelivery API p. 58

A.5 MSGG_N3GDelivery API p. 60

$ Change history p. 63