B.3 Example HTTP multipart message with SMS binary data
29.5403GPP5G SystemRelease 18SMS ServicesStage 3TS
Example HTTP multipart message with SMS binary data:
POST /example.com/nsmsf-sms/v1/ue-contexts/{supi}/sendsms HTTP/2
Content-Type: multipart/related; boundary=—-Boundary
Content-Length: xyz
——Boundary
Content-Type: application/json
{
"smsRecordId": "777c3edf-129f-486e-a3f8-c48e7b515605",
"smsPayload": {
"contentId": "sms"
},
"gpsi": "msisdn-8613915900000",
"pei": "imei-123456789012345",
"accessType": "3GPP_ACCESS",
"ueLocation": {
"nrLocation": {
"tai": {
"plmnId": {
"mcc": "46",
"mnc": "000"
},
"tac": "A01001",
"ncgi": {
"plmnId": {
"mcc": "46",
"mnc": "000"
},
"nrCellId": "225BD6007"
}
}
},
"ueTimeZone": "+08:00"
}
——Boundary
Content-Type: application/vnd.3gpp.sms
Content-Id: sms
{ … SMS Message binary data …}
——Boundary
The JSON part of the HTTP POST message includes an attribute named "smsPayload" which refers to RefToBinaryData structure. The "contentId" of RefToBinaryData is encoded as a string and used to reference the value of the Content-ID header field of the binary body part.
Annex C (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2017-10 |
CT4#80 |
C4-175084 |
Initial Draft. |
0.1.0 |
|||
|
2017-10 |
CT4#80 |
C4-175399 |
Implementation of C4-175281, C4-175282, C4-175284. |
0.2.0 |
|||
|
2017-12 |
CT4#81 |
C4-176441 |
Implementation of C4-176092, C4-176097, C4-176346, C4-176347, C4-176349, C4-176351, C4-176353. |
0.3.0 |
|||
|
2018-03 |
CT4#83 |
C4-182439 |
Implementation of C4-182300, C4-182301, C4-182303, C4-182416 |
0.4.0 |
|||
|
2018-04 |
CT4#84 |
C4-183520 |
Implementation of C4-183375, C4-183376, C4-183377, C4-183378, C4-183379. |
0.5.0 |
|||
|
2018-05 |
CT4#85 |
C4-184633 |
Implementation of C4-184467, C4-184605, C4-184470, C4-184473, C4-184474, C4-184634. |
0.6.0 |
|||
|
2018-06 |
CT#80 |
CP-181109 |
Presented for information and approval |
1.0.0 |
|||
|
2018-06 |
CT#80 |
Approved in CT#80. |
15.0.0 |
||||
|
2018-09 |
CT#81 |
CP-182064 |
0002 |
1 |
F |
Change to Common Data Type |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0003 |
1 |
F |
Correct HTTP Response Code |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0004 |
1 |
F |
Add Missing Parameters |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0005 |
– |
F |
Clarify the Format of SMS Record ID |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0006 |
– |
F |
Add support of 5G Trace |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0007 |
2 |
F |
Backup AMF Info |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0008 |
– |
F |
Description of Structured data types |
15.1.0 |
|
2018-09 |
CT#81 |
CP-182064 |
0009 |
1 |
F |
API Version Update |
15.1.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0010 |
1 |
F |
API Correction |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0011 |
– |
F |
CR cardinality |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0012 |
1 |
F |
NF group Id |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0013 |
– |
F |
APIRoot Clarification |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0014 |
– |
F |
Location Header in HTTP 201 Response |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183023 |
0015 |
– |
F |
Open API version |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183188 |
0016 |
– |
F |
Optionality of OAuth2 |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183189 |
0017 |
– |
F |
Correction of "externalDocs" for Nsmsf_SMService Service |
15.2.0 |
|
2019-03 |
CT#83 |
CP-190069 |
0018 |
2 |
F |
SMS payload |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190028 |
0020 |
– |
F |
API version update |
15.3.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0019 |
2 |
F |
Resolve Editor’s Notes |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0021 |
1 |
F |
Resource URI correction |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0022 |
1 |
F |
API URI Description |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0023 |
2 |
F |
Storage of OpenAPI specification files |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0025 |
1 |
F |
API Version Correction |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0026 |
1 |
F |
Supported Content Type |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0027 |
1 |
F |
Essential Corrections on MultiPart Message |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0029 |
1 |
F |
Copyright Note in YAML file |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191040 |
0031 |
1 |
F |
3GPP TS 29.540 API Version Update |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191057 |
0024 |
– |
B |
Remove useless and misleading application error |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192112 |
0033 |
1 |
F |
Decouple uplinkSMS Response with SMS-C Communication |
16.1.0 |
|
2019-09 |
CT#85 |
CP-192123 |
0034 |
– |
F |
CRLF between Header fields and Data |
16.1.0 |
|
2019-09 |
CT#85 |
CP-192120 |
0036 |
– |
F |
29.540 Rel-16 Open API version externalDocs |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193044 |
0040 |
– |
F |
29.540 Rel-16 API version and External doc update |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200039 |
0041 |
2 |
F |
Add Corresponding API descriptions in clause 5.1 |
16.3.0 |
|
2020-03 |
CT#87 |
CP-200039 |
0042 |
2 |
F |
Correction – formatting consistency |
16.3.0 |
|
2020-03 |
CT#87 |
CP-200033 |
0043 |
– |
B |
RAT Type |
16.3.0 |
|
2020-03 |
CT#87 |
CP-200020 |
0044 |
2 |
F |
Optionality of ProblemDetails |
16.3.0 |
|
2020-03 |
CT#87 |
CP-200052 |
0045 |
– |
F |
API version and External doc update |
16.3.0 |
|
2020-06 |
CT#88 |
CP-201059 |
0046 |
1 |
F |
Supported Headers table for response code 201 |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201059 |
0047 |
1 |
F |
Binary Data Types Table |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201024 |
0048 |
1 |
F |
Correct the Data Type Descriptions |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201059 |
0051 |
1 |
F |
Data type column in Resource URI variables Table |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201059 |
0052 |
1 |
F |
Add custom operation Name |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201024 |
0054 |
– |
F |
Essential Corrections |
16.4.0 |
|
2020-06 |
CT#88 |
CP-201073 |
0055 |
– |
F |
API version and External doc update |
16.4.0 |
|
2020-09 |
CT#89 |
CP-202101 |
0056 |
1 |
F |
Storage of YAML files in 3GPP Forge |
16.5.0 |
|
2020-09 |
CT#89 |
CP-202096 |
0057 |
– |
F |
API version and External doc update |
16.5.0 |
|
2020-12 |
CT#90 |
CP-203027 |
0059 |
1 |
F |
Correction to support multiple access type for SMS |
16.6.0 |
|
2020-12 |
CT#90 |
CP-203054 |
0060 |
1 |
F |
HTTP 3xx redirection |
16.6.0 |
|
2020-12 |
CT#90 |
CP-203048 |
0064 |
1 |
F |
Essential corrections |
16.6.0 |
|
2020-12 |
CT#90 |
CP-203027 |
0066 |
2 |
F |
Header check at deactivation of SMS service |
16.6.0 |
|
2020-12 |
CT#90 |
CP-203036 |
0069 |
– |
F |
API version and External doc update |
16.6.0 |
|
2021-03 |
CT#91 |
CP-210062 |
0074 |
– |
F |
Etag in 204 Response |
16.7.0 |
|
2021-03 |
CT#91 |
CP-210054 |
0078 |
– |
F |
API version and External doc update |
16.7.0 |
|
2021-03 |
CT#91 |
CP-210021 |
0072 |
1 |
B |
Home Network Public Key identifier as additional input for SMSF service |
17.0.0 |
|
2021-03 |
CT#91 |
CP-210034 |
0075 |
– |
F |
Editorial and reference errors |
17.0.0 |
|
2021-03 |
CT#91 |
CP-210034 |
0076 |
1 |
F |
OpenAPI Reference |
17.0.0 |
|
2021-03 |
CT#91 |
CP-210029 |
0077 |
– |
F |
API version and External doc update |
17.0.0 |
|
2021-06 |
CT#92 |
CP-211028 |
0080 |
– |
F |
Adding some missing description fields to data type definitions in the OpenAPI specification file of the Nsmsf_SMService API |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211177 |
0082 |
2 |
F |
Redirect Response |
17.1.0 |
|
2021-06 |
CT#92 |
CP-211050 |
0083 |
– |
F |
29.540 Rel-17 API version and External doc update |
17.1.0 |
|
2021-09 |
CT#93 |
CP-212026 |
0085 |
1 |
F |
SMSF dual access registration |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212060 |
0087 |
– |
F |
3xx description correction for SCP |
17.2.0 |
|
2021-09 |
CT#93 |
CP-212059 |
0088 |
– |
F |
29.540 Rel-17 API version and External doc update |
17.2.0 |
|
2021-12 |
CT#94 |
CP-213087 |
0090 |
1 |
F |
Removal of backupAmfInfo |
17.3.0 |
|
2021-12 |
CT#94 |
CP-213121 |
0091 |
– |
F |
29.540 Rel-17 API version and External doc update |
17.3.0 |
|
2022-03 |
CT#95 |
CP-220024 |
0093 |
3 |
F |
Introduce HTTP PATCH Method |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220024 |
0094 |
– |
F |
Simplify 307/308 Response in OpenAPI |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220026 |
0096 |
1 |
A |
3xx Redirect Response |
17.4.0 |
|
2022-03 |
CT#95 |
CP-220066 |
0097 |
– |
F |
29.540 Rel-17 API version and External doc update |
17.4.0 |
|
2022-06 |
CT#96 |
CP-221027 |
0099 |
– |
F |
Correction of typos in description fields |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221054 |
0100 |
– |
F |
Correction on USER_NOT_FOUND error |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221090 |
0103 |
2 |
B |
MtForwardSm service operation |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221031 |
0104 |
1 |
B |
Removal of the NOTE on interaction between SMSF and SMS-GMSC/IWMSC/IP-SM-GW/SMS Router |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221051 |
0105 |
– |
B |
29.540 Rel-17 API version and External doc update |
17.5.0 |
|
2022-09 |
CT#97 |
CP-222026 |
0106 |
1 |
F |
Partial success in PATCH |
17.6.0 |
|
2022-09 |
CT#97 |
CP-222058 |
0107 |
– |
F |
29.540 Rel-17 API version and External doc update |
17.6.0 |
|
2022-12 |
CT#98 |
CP-223028 |
0108 |
1 |
F |
Missing Mandatory Status Codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223033 |
0109 |
– |
F |
29.540 Rel-18 API version and External doc update |
18.0.0 |