Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 26.510
Word version: 18.0.2
1…
4…
4
Functions and roles
5
Interactions
6
3GPP Service URL
7
General aspects of network APIs
8
Maf_Provisioning service
9
Maf_SessionHandling service
10
Ancillary network media session handling services
11
UE media session handling APIs
A
OpenAPI representation of HTTP REST APIs
B
Controlled vocabularies
C
Usage of TOS/DSCP for traffic identification
$
Change history
4
Functions and roles
p. 21
4.1
Media Application Provider
p. 21
4.2
Media AF
p. 21
4.3
Media Session Handler
p. 21
5
Interactions
p. 22
5.1
Summary
p. 22
5.2
Provisioning (M1) interactions
p. 24
5.2.1
Overview
p. 24
5.2.2
Provisioning Session provisioning
p. 25
5.2.2.1
General
p. 25
5.2.2.2
Enumerate Provisioning Sessions collection operation
p. 25
5.2.2.3
Create Provisioning Session resource operation
p. 26
5.2.2.4
Retrieve Provisioning Session resource operation
p. 26
5.2.2.5
Update Provisioning Session resource operation
p. 26
5.2.2.6
Destroy Provisioning Session resource operation
p. 26
5.2.3
Content protocols discovery
p. 26
5.2.3.1
General
p. 26
5.2.3.2
Create Content Protocols resource operation
p. 27
5.2.3.3
Retrieve Content Protocols resource operation
p. 27
5.2.3.4
Update Content Protocols resource operation
p. 27
5.2.3.5
Destroy Content Protocols resource operation
p. 27
5.2.4
Server Certificate provisioning
p. 27
5.2.4.1
General
p. 27
5.2.4.2
Create Server Certificate resource operation
p. 28
5.2.4.3
Reserve Server Certificate resource operation
p. 28
5.2.4.4
Upload Server Certificate resource operation
p. 29
5.2.4.5
Retrieve Server Certificate resource operation
p. 29
5.2.4.6
Update Server Certificate resource operation
p. 29
5.2.4.7
Destroy Server Certificate resource operation
p. 30
5.2.5
Content Preparation provisioning
p. 30
5.2.5.1
General
p. 30
5.2.5.2
Create Content Preparation Template resource operation
p. 30
5.2.5.3
Retrieve Content Preparation Template resource operation
p. 31
5.2.5.4
Update Content Preparation Template resource operation
p. 31
5.2.5.5
Destroy Content Preparation Template resource operation
p. 31
5.2.6
Edge Resources provisioning
p. 32
5.2.6.1
General
p. 32
5.2.6.2
Create Edge Resources Configuration resource operation
p. 32
5.3.6.3
Retrieve Edge Resources Configuration resource operation
p. 32
5.2.6.4
Update Edge Resources Configuration resource operation
p. 32
5.2.6.5
Destroy Edge Resources Configuration resource operation
p. 33
5.2.7
Dynamic Policy provisioning
p. 33
5.2.7.1
General
p. 33
5.2.7.2
Policy Template life-cycle
p. 34
5.2.7.3
Create Policy Template resource operation
p. 36
5.2.7.4
Retrieve Policy Template resource operation
p. 36
5.2.7.5
Update Policy Template resource operation
p. 36
5.2.7.6
Destroy Policy Template resource operation
p. 37
5.2.8
Content Hosting provisioning
p. 37
5.2.8.1
General
p. 37
5.2.8.2
Create Content Hosting Configuration resource operation
p. 37
5.2.8.3
Retrieve Content Hosting Configuration resource operation
p. 38
5.2.8.4
Update Content Hosting Configuration resource operation
p. 38
5.2.8.5
Destroy Content Hosting Configuration resource operation
p. 39
5.2.8.6
Purge Content Hosting cache operation
p. 39
5.2.9
Content Publishing provisioning
p. 39
5.2.9.1
General
p. 39
5.2.9.2
Create Content Publishing Configuration resource operation
p. 40
5.2.9.3
Retrieve Content Publishing Configuration resource operation
p. 41
5.2.9.4
Update Content Publishing Configuration resource operation
p. 41
5.2.9.5
Destroy Content Publishing Configuration resource operation
p. 41
5.2.9.6
Purge Content Publishing cache operation
p. 42
5.2.10
Real-time Media Communication provisioning
p. 42
5.2.10.1
General
p. 42
5.2.10.2
Create Real-time Media Communication Configuration resource operation
p. 42
5.2.10.3
Retrieve Real-time Media Communication Configuration resource operation
p. 43
5.2.10.4
Update Real-time Media Communication Configuration resource operation
p. 43
5.2.10.5
Destroy Real-time Media Communication Configuration resource operation
p. 43
5.2.11
Metrics Reporting provisioning
p. 43
5.2.11.1
General
p. 43
5.2.11.2
Create Metrics Reporting Configuration resource operation
p. 44
5.2.11.3
Retrieve Metrics Reporting Configuration resource operation
p. 44
5.2.11.4
Update Metrics Reporting Configuration resource operation
p. 44
5.2.11.5
Destroy Metrics Reporting Configuration resource operation
p. 45
5.2.12
Consumption Reporting provisioning
p. 45
5.2.12.1
General
p. 45
5.2.12.2
Create Consumption Reporting Configuration resource operation
p. 45
5.2.12.3
Retrieve Consumption Reporting Configuration resource operation
p. 46
5.2.12.4
Update Consumption Reporting Configuration resource operation
p. 46
5.2.12.5
Destroy Consumption Reporting Configuration resource operation
p. 46
5.2.13
Event Data Processing provisioning
p. 46
5.2.13.1
General
p. 46
5.2.13.2
Create Event Data Processing Configuration resource operation
p. 47
5.2.13.3
Retrieve Event Data Processing Configuration resource operation
p. 47
5.2.13.4
Update Event Data Processing Configuration resource operation
p. 47
5.2.13.5
Destroy Event Data Processing Configuration resource operation
p. 48
5.3
Network media session handling (M3, M5) interactions
p. 48
5.3.1
Overview
p. 48
5.3.2
Service Access Information acquisition
p. 48
5.3.2.1
General
p. 48
5.3.2.2
Create Service Access Information resource operation
p. 49
5.3.2.3
Retrieve Service Access Information resource operation
p. 49
5.3.2.4
Update Service Access Information resource operation
p. 49
5.3.2.5
Destroy Service Access Information resource operation
p. 50
5.3.3
Dynamic Policy invocation
p. 50
5.3.3.1
Procedures
p. 50
5.3.3.2
Create Dynamic Policy Instance resource operation
p. 50
5.3.3.3
Retrieve Dynamic Policy Instance resource operation
p. 53
5.3.3.4
Update Dynamic Policy Instance resource operation
p. 53
5.3.3.5
Destroy Dynamic Policy Instance resource operation
p. 53
5.3.4
Network Assistance invocation
p. 54
5.3.4.1
Procedures
p. 54
5.3.4.2
Create Network Assistance Session resource operation
p. 54
5.3.4.3
Retrieve Network Assistance Session resource operation
p. 56
5.3.4.4
Bit rate recommendation request operation
p. 56
5.3.4.5
Delivery boost request operation
p. 57
5.3.4.6
Update Network Assistance Session resource operation
p. 57
5.3.4.7
Destroy Network Assistance Session resource operation
p. 57
5.3.5
Metrics reporting
p. 58
5.3.5.1
Procedures
p. 58
5.3.5.2
Submit metrics report operation
p. 58
5.3.6
Consumption reporting
p. 59
5.3.6.1
Procedures
p. 59
5.3.6.2
Submit consumption report operation
p. 60
5.4
UE media session handling (M6, M11) interactions
p. 61
5.4.1
Overview
p. 61
5.4.2
Media delivery session life-cycle
p. 61
5.4.2.1
Explicit media session handling initiation/termination
p. 61
5.4.2.2
Implicit media session handling initiation/termination
p. 61
5.4.3
Dynamic Policy invocation
p. 62
5.4.4
Network Assistance invocation
p. 62
5.4.5
Metrics reporting
p. 63
5.4.6
Consumption reporting
p. 63
5.5
5GC policy control (N5/N33) interactions
p. 63
5.5.1
Overview
p. 63
5.5.2
Policy control interactions for Policy Template provisioning
p. 63
5.5.3
Policy control interactions for Dynamic Policies
p. 64
5.5.4
Policy control interactions for AF-based Network Assistance
p. 65
5.6
UE modem interactions
p. 67
5.6.1
Overview
p. 67
5.6.2
ANBR-based Network Assistance
p. 67
5.6.3
RAN-based metrics reporting
p. 67
6
3GPP Service URL
p. 68
6.1
General
p. 68
6.2
3GPP Service URL syntax
p. 68
6.3
Handling of 3GPP Service URLs by Media Client
p. 69
7
General aspects of network APIs
p. 69
7.1
Usage of HTTP
p. 69
7.1.1
HTTP protocol version
p. 69
7.1.2
HTTP endpoint addresses
p. 69
7.1.2.1
Default Media AF endpoint address at reference point M1
p. 69
7.1.2.2
Default Media AF endpoint address at reference point M3
p. 69
7.1.2.3
Default Media AF endpoint address at reference point M5
p. 70
7.1.3
HTTP resource URIs and paths
p. 70
7.1.4
Usage of HTTP headers
p. 70
7.1.4.1
General
p. 70
7.1.4.2
User Agent identification
p. 70
7.1.4.3
Server identification
p. 70
7.1.4.2a
Cache control
p. 70
7.1.4.3a
Support for conditional HTTP GET requests
p. 70
7.1.4.4
Support for conditional HTTP POST, PUT, PATCH and DELETE requests
p. 71
7.1.5
HTTP message bodies for API resources
p. 71
7.1.6
HTTP response codes
p. 71
7.1.7
HTTP error response message bodies
p. 71
7.2
Explanation of API data model notation
p. 71
7.3
Common OpenAPI data types
p. 73
7.3.1
General
p. 73
7.3.2
Simple data types
p. 73
7.3.3
Structured data types
p. 74
7.3.3.1
IpPacketFilterSet type
p. 74
7.3.3.2
ApplicationFlowDescription type
p. 74
7.3.3.3
M1UnidirectionalQoSSpecification type
p. 75
7.3.3.4
M1QoSSpecification type
p. 75
7.3.3.5
M5BitRateSpecification type
p. 75
7.3.3.6
M5QoSSpecification type
p. 76
7.3.3.7
ChargingSpecification type
p. 76
7.3.3.8
TypedLocation type
p. 76
7.3.3.9
OperationSuccessResponse type
p. 76
7.3.3.10
EdgeProcessingEligibilityCriteria type
p. 77
7.3.3.11
EndpointAddress type
p. 77
7.3.3.12
M1MediaEntryPoint type
p. 78
7.3.3.13
CachingConfiguration type
p. 78
7.3.3.14
BDTWindow type
p. 79
7.3.4
Enumerated data types
p. 79
7.3.4.1
CellIdentifierType enumeration
p. 79
7.3.4.2
SdfMethod enumeration
p. 79
7.3.4.3
ProvisioningSessionType enumeration
p. 79
7.3.4.4
EASRelocationTolerance enumeration
p. 80
7.3.4.5
ContentTransferMode enumeration
p. 80
7.4
Security
p. 80
7.4.1
General
p. 80
7.4.2
Authorising Media Application Provider access to the Media AF at reference point M1
p. 80
7.4.3
Authorising Media Session Handler access to the Media AF at reference point M5
p. 81
8
Maf_Provisioning service
p. 82
8.1
Overview
p. 82
8.2
Provisioning Sessions API
p. 84
8.2.1
Overview
p. 84
8.2.2
Resource structure
p. 84
8.2.3
Data model
p. 85
8.2.3.1
ProvisioningSession resource
p. 85
8.3
Content Protocols Discovery API
p. 87
8.3.1
Overview
p. 87
8.3.2
Resource structure
p. 87
8.3.3
Data model
p. 88
8.3.3.1
ContentProtocols resource
p. 88
8.3.3.2
ContentProtocolDescriptor type
p. 88
8.4
Server Certificates provisioning API
p. 89
8.4.1
Overview
p. 89
8.4.2
Resource structure
p. 89
8.4.3
Data model
p. 90
8.4.3.1
Certificate Signing Request
p. 90
8.4.3.2
Server Certificate resource
p. 90
8.5
Content Preparation Templates provisioning API
p. 91
8.5.1
Overview
p. 91
8.5.2
Resource structure
p. 91
8.5.3
Data model
p. 91
8.6
Edge Resources provisioning API
p. 92
8.6.1
General
p. 92
8.6.2
Resource structure
p. 92
8.6.3
Data model
p. 93
8.6.3.1
EdgeResourcesConfiguration resource type
p. 93
8.6.3.2
EdgeManagementMode enumeration
p. 93
8.6.3.3
EASRequirements type
p. 94
8.6.3.4
M1EASRelocationRequirements type
p. 94
8.7
Policy Templates provisioning API
p. 95
8.7.1
Overview
p. 95
8.7.2
Resource structure
p. 95
8.7.3
Data model
p. 96
8.7.3.1
PolicyTemplate resource
p. 96
8.7.3.2
M1BDTSpecification type
p. 98
8.8
Content Hosting provisioning API
p. 99
8.8.1
Overview
p. 99
8.8.2
Resource structure
p. 99
8.8.3
Data model
p. 100
8.8.3.1
ContentHostingConfiguration resource
p. 100
8.8.3.2
DistributionNetworkType enumeration
p. 103
8.8.3.3
DistributionMode enumeration
p. 104
8.9
Content Publishing provisioning API
p. 105
8.9.1
Overview
p. 105
8.9.2
Resource structure
p. 105
8.9.3
Data model
p. 106
8.9.3.1
ContentPublishingConfiguration resource
p. 106
8.10
Real-time Media Communication provisioning API
p. 109
8.10.1
Overview
p. 109
8.10.2
Resource structure
p. 109
8.10.3
Data model
p. 110
8.10.3.1
RTCConfiguration resource
p. 110
8.10.3.2
M1EndpointAccess
p. 111
8.11
Metrics Reporting provisioning API
p. 112
8.11.1
Overview
p. 112
8.11.2
Resource structure
p. 112
8.11.3
Data model
p. 113
8.11.3.1
MetricsReportingConfiguration resource
p. 113
8.12
Consumption Reporting provisioning API
p. 115
8.12.1
Overview
p. 115
8.12.2
Resource structure
p. 115
8.12.3
Data model
p. 116
8.12.3.1
ConsumptionReportingConfiguration resource
p. 116
8.13
Event Data Processing provisioning API
p. 117
8.13.1
General
p. 117
8.13.2
Resource structure
p. 117
8.13.3
Data model
p. 118
8.13.3.1
EventDataProcessingConfiguration resource type
p. 118
9
Maf_SessionHandling service
p. 119
9.1
Overview
p. 119
9.2
Service Access Information API
p. 120
9.2.1
General
p. 120
9.2.2
Resource structure
p. 120
9.2.3
Data model
p. 121
9.2.3.1
ServiceAccessInformation resource type
p. 121
9.2.3.2
M5EndpointAccess
p. 126
9.2.3.3
EASDiscoveryTemplate type
p. 126
9.2.3.4
M5EASRelocationRequirements type
p. 127
9.3
Dynamic Policy API
p. 128
9.3.1
Overview
p. 128
9.3.2
Resource structure
p. 128
9.3.3
Data model
p. 129
9.3.3.1
DynamicPolicy resource
p. 129
9.3.3.2
ApplicationFlowBinding
p. 130
9.3.3.3
M5BDTSpecification type
p. 131
9.4
Network Assistance API
p. 132
9.4.1
Overview
p. 132
9.4.2
Resource structure
p. 132
9.4.3
Data model
p. 133
9.4.3.1
NetworkAssistanceSession resource
p. 133
9.5
Metrics Reporting API
p. 134
9.5.1
General
p. 134
9.5.2
Reporting procedure
p. 134
9.5.3
Report format
p. 134
9.6
Consumption Reporting API
p. 135
9.6.1
General
p. 135
9.6.2
Reporting procedure
p. 135
9.6.3
Report format
p. 136
9.6.3.1
ConsumptionReport type
p. 136
9.6.3.2
ConsumptionReportingUnit type
p. 137
10
Ancillary network media session handling services
p. 138
10.1
Overview
p. 138
10.2
Resource update notification channel
p. 138
10.2.1
General
p. 138
10.2.2
Topic structure of notification channel
p. 138
10.2.3
Notification message format
p. 138
11
UE media session handling APIs
p. 140
11.1
Introduction
p. 140
11.2
Media Session Handler client API
p. 140
11.2.1
Media Session Handler internal properties
p. 140
11.2.2
General Media Session Handler methods
p. 141
11.2.2.1
Create a media delivery session
p. 141
11.2.2.2
Destroy a media delivery session
p. 142
11.2.3
General Media Session Handler information
p. 142
11.3
Dynamic Policy client API
p. 144
11.3.1
Dynamic Policy methods
p. 144
11.3.1.1
Retrieve Background Data Transfer information
p. 144
11.3.1.2
Activate Dynamic Policy
p. 145
11.3.2
Dynamic Policy information
p. 146
11.4
Network Assistance client API
p. 147
11.4.1
Network Assistance methods
p. 147
11.4.1.1
Bit rate recommendation request
p. 147
11.4.1.2
Delivery boost request
p. 147
11.4.2
Network Assistance information
p. 147
11.5
Consumption Reporting API
p. 149
11.5.1
Consumption Reporting methods
p. 149
11.5.2
Consumption Reporting information
p. 149
11.6
Metrics Reporting client API
p. 150
11.6.1
Consumption Reporting methods
p. 150
11.6.2
Metrics Reporting information
p. 150
A
(Normative) OpenAPI representation of HTTP REST APIs
p. 152
A.1
General
p. 152
A.2
Data Types applicable to several APIs
p. 152
A.3
OpenAPI representation of Maf_Provisioning APIs
p. 152
A.3.1
Maf_Provisioning_ProvisioningSessions API
p. 152
A.3.2
Maf_Provisioning_ContentProtocols API
p. 152
A.3.3
Maf_Provisioning_ServerCertificates API
p. 152
A.3.4
Maf_Provisioning_ContentPreparationTemplates API
p. 152
A.3.5
Maf_Provisioning_EdgeResources API
p. 152
A.3.6
Maf_Provisioning_PolicyTemplates API
p. 153
A.3.7
Maf_Provisioning_ContentHosting API
p. 153
A.3.8
Maf_Provisioning_ContentPublishing API
p. 153
A.3.9
Maf_Provisioning_RealTimeCommunication API
p. 153
A.3.9a
Maf_Provisioning_MetricsReporting API
p. 153
A.3.10
Maf_Provisioning_ConsumptionReporting API
p. 153
A.3.11
Maf_Provisioning_EventDataProcessing API
p. 153
A.4
OpenAPI representation of Maf_SessionHandling APIs
p. 153
A.4.1
Maf_SessionHandling_ServiceAccessInformation API
p. 153
A.4.2
Maf_SessionHandling_DynamicPolicy API
p. 153
A.4.3
Maf_SessionHandling_NetworkAssistance API
p. 154
A.4.4
Maf_SessionHandling_MetricsReporting API
p. 154
A.4.5
Maf_SessionHandling_ConsumptionReporting API
p. 154
B
(Normative) Controlled vocabularies
p. 155
B.1
Media Delivery locator type
p. 155
C
Usage of TOS/DSCP for traffic identification
p. 156
C.1
General
p. 156
C.2
Differentiated Services/TOS-enabled Collaboration Scenarios
p. 156
C.3
Procedure for using TOS Traffic Class for traffic identification
p. 157
$
Change history
p. 160