Content for TS 29.538 Word version: 18.4.0
5 Services offered by the MSGin5G Servers
6 Services offered by the Message Gateway
7 Common information applicable to several APIs
8 Message Server API definition
9 Message Gateway API definition
10 Security
11 Using Common API Framework
11.1 General
11.2 Security
12 Usage of Network Capabilities
A OpenAPI specification
$ Change history
5 Services offered by the MSGin5G Servers p. 13
5.1 Introduction p. 13
5.2 MSGS_ASRegistration Service p. 14
5.2.1 Service Description p. 14
5.2.2 Service Operations p. 14
5.3 MSGS_MSGDelivery Service p. 16
5.3.1 Service Description p. 16
5.3.2 Service Operations p. 16
5.4 MSGS_TopiclistEvent |R18| p. 20
5.4.1 Service Description p. 20
5.4.2 Service Operations p. 21
5.4.2.1 Introduction p. 21
5.4.2.2 MSGS_TopiclistEvent_SubscribeMSGTopiclist p. 21
5.4.2.3 MSGS_TopiclistEvent_UnsubscribeMSGTopiclist p. 22
5.4.2.3.1 General p. 22
5.4.2.3.2 MSGin5G Server Unsubscribing to MSGin5G Messaging Topic List p. 22
5.4.2.4 MSGS_TopiclistEvent_NotifyMSGTopiclist p. 23
5.4.2.5 MSGS_TopiclistEvent_SubscribeMSGTopic p. 23
5.4.2.6 MSGS_TopiclistEvent_SubscribeMSGTopic p. 24
6 Services offered by the Message Gateway p. 25
6.1 Introduction p. 25
6.2 MSGG_L3GDelivery Service p. 26
6.2.1 Service Description p. 26
6.2.2 Service Operations p. 26
6.3 MSGG_N3GDelivery Service p. 28
6.3.1 Service Description p. 28
6.3.2 Service Operations p. 28
6.4 MSGG_BGDelivery Service |R18| p. 30
7 Common information applicable to several APIs p. 32
7.1 General p. 32
7.2 Data Types p. 32
7.2.1 General p. 32
7.2.2 Referenced structured data types p. 32
7.2.3 Referenced Simple data types and enumerations p. 33
7.3 Usage of HTTP p. 33
7.4 Content type p. 33
7.5 URI structure p. 33
7.6 Notifications p. 33
7.7 Error Handling p. 33
7.8 Feature negotiation p. 33
7.9 HTTP headers p. 34
7.10 Conventions for Open API specification files p. 34
8 Message Server API definition p. 34
8.1 MSGS_ASRegistration API p. 34
8.1.1 API URI p. 34
8.1.2 Resources p. 34
8.1.2.1 Overview p. 34
8.1.2.2 Resource: AS Registrations p. 35
8.1.2.2.1 Description p. 35
8.1.2.2.2 Resource Definition p. 35
8.1.2.2.3 Resource Standard Methods p. 35
8.1.2.2.3.1 POST p. 35
8.1.2.3 Resource: AS DeRegistration p. 36
8.1.2.3.1 Description p. 36
8.1.2.3.2 Resource Definition p. 36
8.1.2.3.3 Resource Standard Methods p. 36
8.1.2.3.3.1 DELETE p. 36
8.1.3 Custom Operations without associated resources p. 37
8.1.4 Notifications p. 37
8.1.5 Data Model p. 37
8.1.5.1 General p. 37
8.1.5.2 Structured data types p. 38
8.1.5.2.1 Introduction p. 38
8.1.5.2.2 Type: ASRegistration p. 38
8.1.5.2.3 Type: ASRegistrationAck p. 38
8.1.5.2.4 Type: ASProfile p. 38
8.1.5.3 Simple data types and enumerations p. 38
8.1.6 Error Handling p. 38
8.1.6.1 General |R18| p. 38
8.1.6.2 Protocol Errors |R18| p. 39
8.1.6.3 Application Errors |R18| p. 39
8.1.7 Feature negotiation p. 39
8.2 MSGS_MSGDelivery API p. 39
8.2.1 API URI p. 39
8.2.2 Resources p. 39
8.2.3 Custom Operations without associated resources p. 39
8.2.3.1 Overview p. 39
8.2.3.2 Operation: deliver-as-message p. 40
8.2.3.2.1 Description p. 40
8.2.3.2.2 Operation Definition p. 40
8.2.3.3 Operation: deliver-ue-message p. 41
8.2.3.3.1 Description p. 41
8.2.3.3.2 Operation Definition p. 41
8.2.3.4 Operation: deliver-report p. 41
8.2.3.4.1 Description p. 41
8.2.3.4.2 Operation Definition p. 41
8.2.4 Notifications p. 41
8.2.5 Data Model p. 42
8.2.5.1 General p. 42
8.2.5.2 Structured data types p. 43
8.2.5.2.1 Introduction p. 43
8.2.5.2.2 Type: ASMessageDelivery p. 43
8.2.5.2.3 Type:UEMessageDelivery p. 44
8.2.5.2.4 Type: MessageDeliveryAck p. 44
8.2.5.2.5 Type:MessageSegmentParameters p. 45
8.2.5.2.6 Type:StoreAndForwardParameters p. 45
8.2.5.2.7 Type:DeliveryStatusReport p. 45
8.2.5.3 Simple data types and enumerations p. 45
8.2.6 Error Handling p. 46
8.2.6.1 General |R18| p. 46
8.2.6.2 Protocol Errors |R18| p. 46
8.2.6.3 Application Errors |R18| p. 46
8.2.7 Feature negotiation p. 46
8.3 MSGS_TopiclistEvent API |R18| p. 47
8.3.1 API URI p. 47
8.3.2 Resources p. 47
8.3.2.1 Overview p. 47
8.3.2.2 Resource: Topic List Subscriptions p. 47
8.3.2.2.1 Description p. 47
8.3.2.2.2 Resource Definition p. 47
8.3.2.2.3 Resource Standard Methods p. 48
8.3.2.2.3.1 POST p. 48
8.3.2.3 Resource: Individual Topic List Subscription p. 48
8.3.2.3.1 Description p. 48
8.3.2.3.2 Resource Definition p. 49
8.3.2.3.3 Resource Standard Methods p. 49
8.3.2.3.3.1 POST p. 49
8.3.3 Custom Operations without associated resources p. 50
8.3.3.1 Overview p. 50
8.3.3.2 Operation: request-topic-subscription p. 50
8.3.3.2.1 Description p. 50
8.3.3.2.2 Operation Definition p. 50
8.3.3.3 Operation: request-topic-unsubscription p. 51
8.3.3.3.1 Description p. 51
8.3.3.3.2 Operation Definition p. 51
8.3.4 Notifications p. 51
8.3.4.2 Topiclist Notification p. 51
8.3.4.2.1 Description p. 51
8.3.4.2.2 Target URI p. 52
8.3.4.2.3 Standard Methods p. 52
8.3.4.2.3.1 POST p. 52
8.3.5 Data Model p. 52
8.3.5.1 General p. 52
8.3.5.2 Structured data types p. 53
8.3.5.2.1 Introduction p. 53
8.3.5.2.2 Type: TopicListSubscription p. 53
8.3.5.2.3 Type: TopicListUnsubscription p. 54
8.3.5.2.4 Type: TopicListSubscriptionAck p. 54
8.3.5.2.5 Type: TopicListUnsubscriptionAck p. 54
8.3.5.2.6 Type: TopicSubscription p. 54
8.3.5.2.7 Type: TopicSubscriptionAck p. 54
8.3.5.2.8 Type: TopicUnsubscription p. 55
8.3.5.2.9 Type: TopicListNotification p. 55
8.3.5.2.10 Type: MessagingTopic p. 55
8.3.5.3 Simple data types and enumerations p. 55
8.3.6 Error Handling p. 55
8.3.7 Feature negotiation p. 56
9 Message Gateway API definition p. 56
9.1 MSGG_L3GDelivery API p. 56
9.1.1 API URI p. 56
9.1.2 Resources p. 56
9.1.3 Custom Operations without associated resources p. 56
9.1.3.1 Overview p. 56
9.1.3.2 Operation: deliver-message p. 57
9.1.3.2.1 Description p. 57
9.1.3.2.2 Operation Definition p. 57
9.1.3.3 Operation: deliver-report p. 57
9.1.3.3.1 Description p. 57
9.1.3.3.2 Operation Definition p. 58
9.1.4 Notifications p. 58
9.1.5 Data Model p. 58
9.1.5.1 General p. 58
9.1.5.2 Structured data types p. 59
9.1.5.3 Simple data types and enumerations p. 60
9.1.6 Error Handling p. 60
9.1.6.1 General |R18| p. 60
9.1.6.2 Protocol Errors |R18| p. 60
9.1.6.3 Application Errors |R18| p. 60
9.1.7 Feature negotiation p. 60
9.2 MSGG_N3GDelivery API p. 60
9.2.1 API URI p. 60
9.2.2 Resources p. 61
9.2.3 Custom Operations without associated resources p. 61
9.2.3.1 Overview p. 61
9.2.3.2 Operation: deliver-message p. 61
9.2.3.2.1 Description p. 61
9.2.3.2.2 Operation Definition p. 61
9.2.3.3 Operation: deliver-report p. 62
9.2.3.3.1 Description p. 62
9.2.3.3.2 Operation Definition p. 62
9.2.4 Notifications p. 62
9.2.5 Data Model p. 62
9.2.5.1 General p. 62
9.2.5.2 Structured data types p. 63
9.2.6 Error Handling p. 63
9.2.6.1 General |R18| p. 63
9.2.6.2 Protocol Errors |R18| p. 64
9.2.6.3 Application Errors |R18| p. 64
9.2.7 Feature negotiation p. 64
9.3 MSGG_BGDelivery API |R18| p. 64
9.3.1 API URI p. 64
9.3.2 Resources p. 64
9.3.3 Custom Operations without associated resources p. 64
9.3.3.1 Overview p. 64
9.3.3.2 Operation: deliver-message p. 65
9.3.3.2.1 Description p. 65
9.3.3.2.2 Operation Definition p. 65
9.3.4 Notifications p. 65
9.3.5 Data Model p. 65
9.3.5.1 General p. 65
9.3.5.2 Structured data types p. 67
9.3.5.3 Simple data types and enumerations p. 67
9.3.6 Error Handling p. 67
9.3.7 Feature negotiation p. 68
10 Security p. 68
11 Using Common API Framework p. 68
11.1 General p. 68
11.2 Security p. 68
12 Usage of Network Capabilities p. 69
A (Normative) OpenAPI specification p. 70
A.1 General p. 70
A.2 MSGS_ASRegistration API p. 70
A.3 MSGS_MSGDelivery API p. 72
A.4 MSGG_L3GDelivery API p. 77
A.5 MSGG_N3GDelivery API p. 79
$ Change history p. 84
